diff --git a/build/.openapi-generator/FILES b/build/.openapi-generator/FILES
index 7cbbb9fb3..fca70eb93 100644
--- a/build/.openapi-generator/FILES
+++ b/build/.openapi-generator/FILES
@@ -3,6 +3,8 @@
PureCloudPlatformClientV2/__init__.py
PureCloudPlatformClientV2/api_client.py
PureCloudPlatformClientV2/apis/__init__.py
+PureCloudPlatformClientV2/apis/agent_assistants_api.py
+PureCloudPlatformClientV2/apis/agent_copilot_api.py
PureCloudPlatformClientV2/apis/agent_ui_api.py
PureCloudPlatformClientV2/apis/alerting_api.py
PureCloudPlatformClientV2/apis/analytics_api.py
@@ -301,6 +303,7 @@ PureCloudPlatformClientV2/models/analytics_user_details_async_query_response.py
PureCloudPlatformClientV2/models/analytics_user_details_query_response.py
PureCloudPlatformClientV2/models/analytics_user_presence_record.py
PureCloudPlatformClientV2/models/annotation.py
+PureCloudPlatformClientV2/models/answer_generation_config.py
PureCloudPlatformClientV2/models/answer_generation_document.py
PureCloudPlatformClientV2/models/answer_option.py
PureCloudPlatformClientV2/models/api_usage_client_query.py
@@ -367,6 +370,10 @@ PureCloudPlatformClientV2/models/assignment.py
PureCloudPlatformClientV2/models/assignment_error.py
PureCloudPlatformClientV2/models/assignment_validation.py
PureCloudPlatformClientV2/models/assistance_condition.py
+PureCloudPlatformClientV2/models/assistant.py
+PureCloudPlatformClientV2/models/assistant_listing.py
+PureCloudPlatformClientV2/models/assistant_queue.py
+PureCloudPlatformClientV2/models/assistant_queue_listing.py
PureCloudPlatformClientV2/models/associated_value_field.py
PureCloudPlatformClientV2/models/async_conversation_query.py
PureCloudPlatformClientV2/models/async_forecast_operation_result.py
@@ -479,6 +486,8 @@ PureCloudPlatformClientV2/models/bot_summary.py
PureCloudPlatformClientV2/models/bot_version_summary.py
PureCloudPlatformClientV2/models/browser.py
PureCloudPlatformClientV2/models/bu_abandon_rate.py
+PureCloudPlatformClientV2/models/bu_activity_settings_request.py
+PureCloudPlatformClientV2/models/bu_activity_settings_response.py
PureCloudPlatformClientV2/models/bu_agent_schedule_activity.py
PureCloudPlatformClientV2/models/bu_agent_schedule_history_change.py
PureCloudPlatformClientV2/models/bu_agent_schedule_history_change_metadata.py
@@ -525,6 +534,8 @@ PureCloudPlatformClientV2/models/bu_intraday_response.py
PureCloudPlatformClientV2/models/bu_intraday_schedule_data.py
PureCloudPlatformClientV2/models/bu_list_alternative_shift_trades_response.py
PureCloudPlatformClientV2/models/bu_management_unit_schedule_summary.py
+PureCloudPlatformClientV2/models/bu_notification_settings_request.py
+PureCloudPlatformClientV2/models/bu_notification_settings_response.py
PureCloudPlatformClientV2/models/bu_planning_group_headcount_forecast.py
PureCloudPlatformClientV2/models/bu_query_adherence_explanations_request.py
PureCloudPlatformClientV2/models/bu_query_adherence_explanations_response.py
@@ -535,6 +546,9 @@ PureCloudPlatformClientV2/models/bu_reschedule_result.py
PureCloudPlatformClientV2/models/bu_schedule_list_item.py
PureCloudPlatformClientV2/models/bu_schedule_listing.py
PureCloudPlatformClientV2/models/bu_schedule_metadata.py
+PureCloudPlatformClientV2/models/bu_schedule_notifications_category_settings.py
+PureCloudPlatformClientV2/models/bu_schedule_notifications_settings_request.py
+PureCloudPlatformClientV2/models/bu_schedule_notifications_settings_response.py
PureCloudPlatformClientV2/models/bu_schedule_reference.py
PureCloudPlatformClientV2/models/bu_schedule_reference_for_mu_route.py
PureCloudPlatformClientV2/models/bu_schedule_run.py
@@ -671,6 +685,7 @@ PureCloudPlatformClientV2/models/campaign_rule.py
PureCloudPlatformClientV2/models/campaign_rule_action.py
PureCloudPlatformClientV2/models/campaign_rule_action_entities.py
PureCloudPlatformClientV2/models/campaign_rule_condition.py
+PureCloudPlatformClientV2/models/campaign_rule_condition_group.py
PureCloudPlatformClientV2/models/campaign_rule_entities.py
PureCloudPlatformClientV2/models/campaign_rule_entity_listing.py
PureCloudPlatformClientV2/models/campaign_rule_parameters.py
@@ -1085,6 +1100,7 @@ PureCloudPlatformClientV2/models/conversation_notification_template_header.py
PureCloudPlatformClientV2/models/conversation_notification_template_parameter.py
PureCloudPlatformClientV2/models/conversation_participant_search_criteria.py
PureCloudPlatformClientV2/models/conversation_participant_search_request.py
+PureCloudPlatformClientV2/models/conversation_profile.py
PureCloudPlatformClientV2/models/conversation_properties.py
PureCloudPlatformClientV2/models/conversation_public_metadata.py
PureCloudPlatformClientV2/models/conversation_query.py
@@ -1142,6 +1158,13 @@ PureCloudPlatformClientV2/models/conversation_video_event_topic_uri_reference.py
PureCloudPlatformClientV2/models/conversation_video_event_topic_video_conversation.py
PureCloudPlatformClientV2/models/conversation_video_event_topic_video_media_participant.py
PureCloudPlatformClientV2/models/conversation_video_event_topic_wrapup.py
+PureCloudPlatformClientV2/models/copilot.py
+PureCloudPlatformClientV2/models/copilot_action.py
+PureCloudPlatformClientV2/models/copilot_condition.py
+PureCloudPlatformClientV2/models/copilot_fallback_action.py
+PureCloudPlatformClientV2/models/copilot_nlu_domain.py
+PureCloudPlatformClientV2/models/copilot_nlu_domain_version.py
+PureCloudPlatformClientV2/models/copilot_rule.py
PureCloudPlatformClientV2/models/copy_attachments_request.py
PureCloudPlatformClientV2/models/copy_bu_forecast_request.py
PureCloudPlatformClientV2/models/copy_voicemail_message.py
@@ -1232,6 +1255,7 @@ PureCloudPlatformClientV2/models/cta_button_style_properties.py
PureCloudPlatformClientV2/models/current_user_schedule_request_body.py
PureCloudPlatformClientV2/models/current_user_time_off_integration_status_request.py
PureCloudPlatformClientV2/models/cursor_contact_listing.py
+PureCloudPlatformClientV2/models/cursor_external_source_listing.py
PureCloudPlatformClientV2/models/cursor_note_listing.py
PureCloudPlatformClientV2/models/cursor_organization_listing.py
PureCloudPlatformClientV2/models/cursor_relationship_listing.py
@@ -1815,6 +1839,7 @@ PureCloudPlatformClientV2/models/facet_statistics.py
PureCloudPlatformClientV2/models/facet_term.py
PureCloudPlatformClientV2/models/failed_object.py
PureCloudPlatformClientV2/models/failed_recording_entity_listing.py
+PureCloudPlatformClientV2/models/fallback.py
PureCloudPlatformClientV2/models/faq.py
PureCloudPlatformClientV2/models/fax_config.py
PureCloudPlatformClientV2/models/fax_document.py
@@ -1984,6 +2009,7 @@ PureCloudPlatformClientV2/models/gkn_documentation_result.py
PureCloudPlatformClientV2/models/gkn_documentation_search_criteria.py
PureCloudPlatformClientV2/models/gkn_documentation_search_request.py
PureCloudPlatformClientV2/models/gkn_documentation_search_response.py
+PureCloudPlatformClientV2/models/google_dialogflow_config.py
PureCloudPlatformClientV2/models/google_dialogflow_custom_settings.py
PureCloudPlatformClientV2/models/grammar.py
PureCloudPlatformClientV2/models/grammar_file_upload_request.py
@@ -2299,6 +2325,9 @@ PureCloudPlatformClientV2/models/knowledge_aggregate_query_predicate.py
PureCloudPlatformClientV2/models/knowledge_aggregate_query_response.py
PureCloudPlatformClientV2/models/knowledge_aggregation_query.py
PureCloudPlatformClientV2/models/knowledge_aggregation_view.py
+PureCloudPlatformClientV2/models/knowledge_answer_config.py
+PureCloudPlatformClientV2/models/knowledge_answer_document_response.py
+PureCloudPlatformClientV2/models/knowledge_answer_documents_response.py
PureCloudPlatformClientV2/models/knowledge_answer_generation_response.py
PureCloudPlatformClientV2/models/knowledge_async_aggregate_query_response.py
PureCloudPlatformClientV2/models/knowledge_async_aggregation_query.py
@@ -2307,6 +2336,7 @@ PureCloudPlatformClientV2/models/knowledge_base_create_request.py
PureCloudPlatformClientV2/models/knowledge_base_listing.py
PureCloudPlatformClientV2/models/knowledge_base_reference.py
PureCloudPlatformClientV2/models/knowledge_base_update_request.py
+PureCloudPlatformClientV2/models/knowledge_base_with_dialect_reference.py
PureCloudPlatformClientV2/models/knowledge_category.py
PureCloudPlatformClientV2/models/knowledge_category_request.py
PureCloudPlatformClientV2/models/knowledge_context_reference.py
@@ -2326,6 +2356,7 @@ PureCloudPlatformClientV2/models/knowledge_document_copy.py
PureCloudPlatformClientV2/models/knowledge_document_feedback.py
PureCloudPlatformClientV2/models/knowledge_document_feedback_response.py
PureCloudPlatformClientV2/models/knowledge_document_feedback_response_listing.py
+PureCloudPlatformClientV2/models/knowledge_document_feedback_update_request.py
PureCloudPlatformClientV2/models/knowledge_document_guest_search.py
PureCloudPlatformClientV2/models/knowledge_document_guest_search_request.py
PureCloudPlatformClientV2/models/knowledge_document_guest_search_result.py
@@ -2351,12 +2382,15 @@ PureCloudPlatformClientV2/models/knowledge_document_version_variation.py
PureCloudPlatformClientV2/models/knowledge_document_version_variation_listing.py
PureCloudPlatformClientV2/models/knowledge_document_version_variation_reference.py
PureCloudPlatformClientV2/models/knowledge_document_view.py
+PureCloudPlatformClientV2/models/knowledge_documents_answer_filter.py
PureCloudPlatformClientV2/models/knowledge_export_job_documents_filter.py
PureCloudPlatformClientV2/models/knowledge_export_job_filter.py
PureCloudPlatformClientV2/models/knowledge_export_job_request.py
PureCloudPlatformClientV2/models/knowledge_export_job_response.py
PureCloudPlatformClientV2/models/knowledge_extended_category.py
PureCloudPlatformClientV2/models/knowledge_group_statistics.py
+PureCloudPlatformClientV2/models/knowledge_guest_answer_document_response.py
+PureCloudPlatformClientV2/models/knowledge_guest_answer_documents_response.py
PureCloudPlatformClientV2/models/knowledge_guest_document_copy.py
PureCloudPlatformClientV2/models/knowledge_guest_document_feedback.py
PureCloudPlatformClientV2/models/knowledge_guest_document_presentation.py
@@ -2394,6 +2428,7 @@ PureCloudPlatformClientV2/models/knowledge_search_document_response.py
PureCloudPlatformClientV2/models/knowledge_search_document_v1.py
PureCloudPlatformClientV2/models/knowledge_search_request.py
PureCloudPlatformClientV2/models/knowledge_search_response.py
+PureCloudPlatformClientV2/models/knowledge_suggestion_config.py
PureCloudPlatformClientV2/models/knowledge_training.py
PureCloudPlatformClientV2/models/kpi_result.py
PureCloudPlatformClientV2/models/label.py
@@ -2712,6 +2747,7 @@ PureCloudPlatformClientV2/models/named_entity_type_mechanism.py
PureCloudPlatformClientV2/models/namespace_docs.py
PureCloudPlatformClientV2/models/network_connectivity.py
PureCloudPlatformClientV2/models/next_occurrence_details.py
+PureCloudPlatformClientV2/models/nlu_config.py
PureCloudPlatformClientV2/models/nlu_confusion_matrix_column.py
PureCloudPlatformClientV2/models/nlu_confusion_matrix_row.py
PureCloudPlatformClientV2/models/nlu_detection_context.py
@@ -3498,6 +3534,8 @@ PureCloudPlatformClientV2/models/routing_status_detail_query_clause.py
PureCloudPlatformClientV2/models/routing_status_detail_query_filter.py
PureCloudPlatformClientV2/models/routing_status_detail_query_predicate.py
PureCloudPlatformClientV2/models/routing_transfer_event.py
+PureCloudPlatformClientV2/models/rule_config.py
+PureCloudPlatformClientV2/models/rule_engine_config.py
PureCloudPlatformClientV2/models/rule_set.py
PureCloudPlatformClientV2/models/rule_set_diagnostic.py
PureCloudPlatformClientV2/models/rule_set_entity_listing.py
@@ -3750,6 +3788,7 @@ PureCloudPlatformClientV2/models/suggestion_knowledge_article.py
PureCloudPlatformClientV2/models/suggestion_knowledge_search.py
PureCloudPlatformClientV2/models/suggestion_listing.py
PureCloudPlatformClientV2/models/suggestion_script.py
+PureCloudPlatformClientV2/models/summary_generation_config.py
PureCloudPlatformClientV2/models/support_center_category.py
PureCloudPlatformClientV2/models/support_center_compact_category_module_template.py
PureCloudPlatformClientV2/models/support_center_custom_message.py
@@ -3936,6 +3975,7 @@ PureCloudPlatformClientV2/models/transcript_topic.py
PureCloudPlatformClientV2/models/transcript_topics.py
PureCloudPlatformClientV2/models/transcript_url.py
PureCloudPlatformClientV2/models/transcript_urls.py
+PureCloudPlatformClientV2/models/transcription_config.py
PureCloudPlatformClientV2/models/transcription_engines_request.py
PureCloudPlatformClientV2/models/transcription_settings.py
PureCloudPlatformClientV2/models/transcription_topic_transcript_alternative.py
@@ -4598,6 +4638,7 @@ PureCloudPlatformClientV2/models/workitem_change_listing.py
PureCloudPlatformClientV2/models/workitem_create.py
PureCloudPlatformClientV2/models/workitem_delta.py
PureCloudPlatformClientV2/models/workitem_filter.py
+PureCloudPlatformClientV2/models/workitem_flow_reference.py
PureCloudPlatformClientV2/models/workitem_manual_assign.py
PureCloudPlatformClientV2/models/workitem_paged_entity_listing.py
PureCloudPlatformClientV2/models/workitem_post_query_entity_listing.py
@@ -4610,6 +4651,7 @@ PureCloudPlatformClientV2/models/workitem_query_post_request.py
PureCloudPlatformClientV2/models/workitem_query_sort.py
PureCloudPlatformClientV2/models/workitem_queue_reference.py
PureCloudPlatformClientV2/models/workitem_reference.py
+PureCloudPlatformClientV2/models/workitem_rule_settings.py
PureCloudPlatformClientV2/models/workitem_schema.py
PureCloudPlatformClientV2/models/workitem_scored_agent.py
PureCloudPlatformClientV2/models/workitem_scored_agent_request.py
@@ -4677,6 +4719,7 @@ PureCloudPlatformClientV2/models/wrap_up_code_reference.py
PureCloudPlatformClientV2/models/wrapup.py
PureCloudPlatformClientV2/models/wrapup_code.py
PureCloudPlatformClientV2/models/wrapup_code_entity_listing.py
+PureCloudPlatformClientV2/models/wrapup_code_prediction_config.py
PureCloudPlatformClientV2/models/wrapup_code_request.py
PureCloudPlatformClientV2/models/wrapup_detail_event_topic_wrapup_event.py
PureCloudPlatformClientV2/models/wrapup_id_reference.py
@@ -4800,6 +4843,8 @@ docs/AgentActivityChangedTopicOutOfOffice.md
docs/AgentActivityChangedTopicPresence.md
docs/AgentActivityChangedTopicRoutingStatus.md
docs/AgentActivityEntityListing.md
+docs/AgentAssistantsApi.json
+docs/AgentAssistantsApi.md
docs/AgentBidWorkPlanOverrideRequest.md
docs/AgentCopilotAggregateDataContainer.md
docs/AgentCopilotAggregateQueryClause.md
@@ -4808,6 +4853,8 @@ docs/AgentCopilotAggregateQueryPredicate.md
docs/AgentCopilotAggregateQueryResponse.md
docs/AgentCopilotAggregationQuery.md
docs/AgentCopilotAggregationView.md
+docs/AgentCopilotApi.json
+docs/AgentCopilotApi.md
docs/AgentCopilotAsyncAggregateQueryResponse.md
docs/AgentCopilotAsyncAggregationQuery.md
docs/AgentCountRange.md
@@ -4912,6 +4959,7 @@ docs/AnalyticsUserDetailsAsyncQueryResponse.md
docs/AnalyticsUserDetailsQueryResponse.md
docs/AnalyticsUserPresenceRecord.md
docs/Annotation.md
+docs/AnswerGenerationConfig.md
docs/AnswerGenerationDocument.md
docs/AnswerOption.md
docs/ApiUsageClientQuery.md
@@ -4980,6 +5028,10 @@ docs/Assignment.md
docs/AssignmentError.md
docs/AssignmentValidation.md
docs/AssistanceCondition.md
+docs/Assistant.md
+docs/AssistantListing.md
+docs/AssistantQueue.md
+docs/AssistantQueueListing.md
docs/AssociatedValueField.md
docs/AsyncConversationQuery.md
docs/AsyncForecastOperationResult.md
@@ -5098,6 +5150,8 @@ docs/BotSummary.md
docs/BotVersionSummary.md
docs/Browser.md
docs/BuAbandonRate.md
+docs/BuActivitySettingsRequest.md
+docs/BuActivitySettingsResponse.md
docs/BuAgentScheduleActivity.md
docs/BuAgentScheduleHistoryChange.md
docs/BuAgentScheduleHistoryChangeMetadata.md
@@ -5144,6 +5198,8 @@ docs/BuIntradayResponse.md
docs/BuIntradayScheduleData.md
docs/BuListAlternativeShiftTradesResponse.md
docs/BuManagementUnitScheduleSummary.md
+docs/BuNotificationSettingsRequest.md
+docs/BuNotificationSettingsResponse.md
docs/BuPlanningGroupHeadcountForecast.md
docs/BuQueryAdherenceExplanationsRequest.md
docs/BuQueryAdherenceExplanationsResponse.md
@@ -5154,6 +5210,9 @@ docs/BuRescheduleResult.md
docs/BuScheduleListItem.md
docs/BuScheduleListing.md
docs/BuScheduleMetadata.md
+docs/BuScheduleNotificationsCategorySettings.md
+docs/BuScheduleNotificationsSettingsRequest.md
+docs/BuScheduleNotificationsSettingsResponse.md
docs/BuScheduleReference.md
docs/BuScheduleReferenceForMuRoute.md
docs/BuScheduleRun.md
@@ -5290,6 +5349,7 @@ docs/CampaignRule.md
docs/CampaignRuleAction.md
docs/CampaignRuleActionEntities.md
docs/CampaignRuleCondition.md
+docs/CampaignRuleConditionGroup.md
docs/CampaignRuleEntities.md
docs/CampaignRuleEntityListing.md
docs/CampaignRuleParameters.md
@@ -5712,6 +5772,7 @@ docs/ConversationNotificationTemplateHeader.md
docs/ConversationNotificationTemplateParameter.md
docs/ConversationParticipantSearchCriteria.md
docs/ConversationParticipantSearchRequest.md
+docs/ConversationProfile.md
docs/ConversationProperties.md
docs/ConversationPublicMetadata.md
docs/ConversationQuery.md
@@ -5771,6 +5832,13 @@ docs/ConversationVideoEventTopicVideoMediaParticipant.md
docs/ConversationVideoEventTopicWrapup.md
docs/ConversationsApi.json
docs/ConversationsApi.md
+docs/Copilot.md
+docs/CopilotAction.md
+docs/CopilotCondition.md
+docs/CopilotFallbackAction.md
+docs/CopilotNluDomain.md
+docs/CopilotNluDomainVersion.md
+docs/CopilotRule.md
docs/CopyAttachmentsRequest.md
docs/CopyBuForecastRequest.md
docs/CopyVoicemailMessage.md
@@ -5861,6 +5929,7 @@ docs/CtaButtonStyleProperties.md
docs/CurrentUserScheduleRequestBody.md
docs/CurrentUserTimeOffIntegrationStatusRequest.md
docs/CursorContactListing.md
+docs/CursorExternalSourceListing.md
docs/CursorNoteListing.md
docs/CursorOrganizationListing.md
docs/CursorRelationshipListing.md
@@ -6456,6 +6525,7 @@ docs/FacetStatistics.md
docs/FacetTerm.md
docs/FailedObject.md
docs/FailedRecordingEntityListing.md
+docs/Fallback.md
docs/Faq.md
docs/FaxApi.json
docs/FaxApi.md
@@ -6635,6 +6705,7 @@ docs/GetProfilesResponse.md
docs/GetRulesQuery.md
docs/GetTemplatesResponse.md
docs/GetUploadSourceUrlJobStatusResponse.md
+docs/GoogleDialogflowConfig.md
docs/GoogleDialogflowCustomSettings.md
docs/Grammar.md
docs/GrammarFileUploadRequest.md
@@ -6962,6 +7033,9 @@ docs/KnowledgeAggregateQueryPredicate.md
docs/KnowledgeAggregateQueryResponse.md
docs/KnowledgeAggregationQuery.md
docs/KnowledgeAggregationView.md
+docs/KnowledgeAnswerConfig.md
+docs/KnowledgeAnswerDocumentResponse.md
+docs/KnowledgeAnswerDocumentsResponse.md
docs/KnowledgeAnswerGenerationResponse.md
docs/KnowledgeApi.json
docs/KnowledgeApi.md
@@ -6972,6 +7046,7 @@ docs/KnowledgeBaseCreateRequest.md
docs/KnowledgeBaseListing.md
docs/KnowledgeBaseReference.md
docs/KnowledgeBaseUpdateRequest.md
+docs/KnowledgeBaseWithDialectReference.md
docs/KnowledgeCategory.md
docs/KnowledgeCategoryRequest.md
docs/KnowledgeContextReference.md
@@ -6991,6 +7066,7 @@ docs/KnowledgeDocumentCopy.md
docs/KnowledgeDocumentFeedback.md
docs/KnowledgeDocumentFeedbackResponse.md
docs/KnowledgeDocumentFeedbackResponseListing.md
+docs/KnowledgeDocumentFeedbackUpdateRequest.md
docs/KnowledgeDocumentGuestSearch.md
docs/KnowledgeDocumentGuestSearchRequest.md
docs/KnowledgeDocumentGuestSearchResult.md
@@ -7016,12 +7092,15 @@ docs/KnowledgeDocumentVersionVariation.md
docs/KnowledgeDocumentVersionVariationListing.md
docs/KnowledgeDocumentVersionVariationReference.md
docs/KnowledgeDocumentView.md
+docs/KnowledgeDocumentsAnswerFilter.md
docs/KnowledgeExportJobDocumentsFilter.md
docs/KnowledgeExportJobFilter.md
docs/KnowledgeExportJobRequest.md
docs/KnowledgeExportJobResponse.md
docs/KnowledgeExtendedCategory.md
docs/KnowledgeGroupStatistics.md
+docs/KnowledgeGuestAnswerDocumentResponse.md
+docs/KnowledgeGuestAnswerDocumentsResponse.md
docs/KnowledgeGuestDocumentCopy.md
docs/KnowledgeGuestDocumentFeedback.md
docs/KnowledgeGuestDocumentPresentation.md
@@ -7059,6 +7138,7 @@ docs/KnowledgeSearchDocumentResponse.md
docs/KnowledgeSearchDocumentV1.md
docs/KnowledgeSearchRequest.md
docs/KnowledgeSearchResponse.md
+docs/KnowledgeSuggestionConfig.md
docs/KnowledgeTraining.md
docs/KpiResult.md
docs/Label.md
@@ -7394,6 +7474,7 @@ docs/NamedEntityTypeMechanism.md
docs/NamespaceDocs.md
docs/NetworkConnectivity.md
docs/NextOccurrenceDetails.md
+docs/NluConfig.md
docs/NluConfusionMatrixColumn.md
docs/NluConfusionMatrixRow.md
docs/NluDetectionContext.md
@@ -8205,6 +8286,8 @@ docs/RoutingStatusDetailQueryClause.md
docs/RoutingStatusDetailQueryFilter.md
docs/RoutingStatusDetailQueryPredicate.md
docs/RoutingTransferEvent.md
+docs/RuleConfig.md
+docs/RuleEngineConfig.md
docs/RuleSet.md
docs/RuleSetDiagnostic.md
docs/RuleSetEntityListing.md
@@ -8473,6 +8556,7 @@ docs/SuggestionKnowledgeArticle.md
docs/SuggestionKnowledgeSearch.md
docs/SuggestionListing.md
docs/SuggestionScript.md
+docs/SummaryGenerationConfig.md
docs/SupportCenterCategory.md
docs/SupportCenterCompactCategoryModuleTemplate.md
docs/SupportCenterCustomMessage.md
@@ -8671,6 +8755,7 @@ docs/TranscriptTopic.md
docs/TranscriptTopics.md
docs/TranscriptUrl.md
docs/TranscriptUrls.md
+docs/TranscriptionConfig.md
docs/TranscriptionEnginesRequest.md
docs/TranscriptionSettings.md
docs/TranscriptionTopicTranscriptAlternative.md
@@ -9355,6 +9440,7 @@ docs/WorkitemChangeListing.md
docs/WorkitemCreate.md
docs/WorkitemDelta.md
docs/WorkitemFilter.md
+docs/WorkitemFlowReference.md
docs/WorkitemManualAssign.md
docs/WorkitemPagedEntityListing.md
docs/WorkitemPostQueryEntityListing.md
@@ -9367,6 +9453,7 @@ docs/WorkitemQueryPostRequest.md
docs/WorkitemQuerySort.md
docs/WorkitemQueueReference.md
docs/WorkitemReference.md
+docs/WorkitemRuleSettings.md
docs/WorkitemSchema.md
docs/WorkitemScoredAgent.md
docs/WorkitemScoredAgentRequest.md
@@ -9434,6 +9521,7 @@ docs/WrapUpCodeReference.md
docs/Wrapup.md
docs/WrapupCode.md
docs/WrapupCodeEntityListing.md
+docs/WrapupCodePredictionConfig.md
docs/WrapupCodeRequest.md
docs/WrapupDetailEventTopicWrapupEvent.md
docs/WrapupIdReference.md
@@ -9463,6 +9551,9 @@ docs/delete_architect_prompts-example.txt
docs/delete_architect_schedule-example.txt
docs/delete_architect_schedulegroup-example.txt
docs/delete_architect_systemprompt_resource-example.txt
+docs/delete_assistant-example.txt
+docs/delete_assistant_queue-example.txt
+docs/delete_assistant_queues-example.txt
docs/delete_authorization_division-example.txt
docs/delete_authorization_division-example.txt
docs/delete_authorization_role-example.txt
@@ -9500,6 +9591,7 @@ docs/delete_employeeperformance_externalmetrics_definition-example.txt
docs/delete_externalcontacts_contact-example.txt
docs/delete_externalcontacts_contact_note-example.txt
docs/delete_externalcontacts_contacts_schema-example.txt
+docs/delete_externalcontacts_externalsource-example.txt
docs/delete_externalcontacts_organization-example.txt
docs/delete_externalcontacts_organization_note-example.txt
docs/delete_externalcontacts_organization_trustor-example.txt
@@ -9826,6 +9918,12 @@ docs/get_architect_systemprompt_history_history_id-example.txt
docs/get_architect_systemprompt_resource-example.txt
docs/get_architect_systemprompt_resources-example.txt
docs/get_architect_systemprompts-example.txt
+docs/get_assistant-example.txt
+docs/get_assistant_copilot-example.txt
+docs/get_assistant_queue-example.txt
+docs/get_assistant_queues-example.txt
+docs/get_assistants-example.txt
+docs/get_assistants_queues-example.txt
docs/get_audits_query_realtime_servicemapping-example.txt
docs/get_audits_query_servicemapping-example.txt
docs/get_audits_query_transaction_id-example.txt
@@ -10014,6 +10112,8 @@ docs/get_externalcontacts_contacts_schema-example.txt
docs/get_externalcontacts_contacts_schema_version-example.txt
docs/get_externalcontacts_contacts_schema_versions-example.txt
docs/get_externalcontacts_contacts_schemas-example.txt
+docs/get_externalcontacts_externalsource-example.txt
+docs/get_externalcontacts_externalsources-example.txt
docs/get_externalcontacts_organization-example.txt
docs/get_externalcontacts_organization_contacts-example.txt
docs/get_externalcontacts_organization_note-example.txt
@@ -10539,6 +10639,7 @@ docs/get_routing_predictor_models-example.txt
docs/get_routing_predictors-example.txt
docs/get_routing_predictors_keyperformanceindicators-example.txt
docs/get_routing_queue-example.txt
+docs/get_routing_queue_assistant-example.txt
docs/get_routing_queue_comparisonperiod-example.txt
docs/get_routing_queue_comparisonperiods-example.txt
docs/get_routing_queue_estimatedwaittime-example.txt
@@ -10942,6 +11043,8 @@ docs/patch_alerting_rules_bulk-example.txt
docs/patch_analytics_reporting_settings-example.txt
docs/patch_architect_grammar-example.txt
docs/patch_architect_grammar_language-example.txt
+docs/patch_assistant-example.txt
+docs/patch_assistant_queues-example.txt
docs/patch_authorization_role-example.txt
docs/patch_authorization_settings-example.txt
docs/patch_chats_room-example.txt
@@ -11014,6 +11117,7 @@ docs/patch_knowledge_guest_session_documents_search_search_id-example.txt
docs/patch_knowledge_knowledgebase-example.txt
docs/patch_knowledge_knowledgebase_category-example.txt
docs/patch_knowledge_knowledgebase_document-example.txt
+docs/patch_knowledge_knowledgebase_document_feedback_feedback_id-example.txt
docs/patch_knowledge_knowledgebase_document_variation-example.txt
docs/patch_knowledge_knowledgebase_documents_search_search_id-example.txt
docs/patch_knowledge_knowledgebase_import_job-example.txt
@@ -11213,6 +11317,7 @@ docs/post_architect_schedulegroups-example.txt
docs/post_architect_schedules-example.txt
docs/post_architect_systemprompt_history-example.txt
docs/post_architect_systemprompt_resources-example.txt
+docs/post_assistants-example.txt
docs/post_audits_query-example.txt
docs/post_audits_query_realtime-example.txt
docs/post_audits_query_realtime_related-example.txt
@@ -11364,6 +11469,7 @@ docs/post_externalcontacts_contact_notes-example.txt
docs/post_externalcontacts_contact_promotion-example.txt
docs/post_externalcontacts_contacts-example.txt
docs/post_externalcontacts_contacts_schemas-example.txt
+docs/post_externalcontacts_externalsources-example.txt
docs/post_externalcontacts_identifierlookup-example.txt
docs/post_externalcontacts_merge_contacts-example.txt
docs/post_externalcontacts_organization_notes-example.txt
@@ -11443,6 +11549,7 @@ docs/post_knowledge_documentuploads-example.txt
docs/post_knowledge_guest_session_document_copies-example.txt
docs/post_knowledge_guest_session_document_feedback-example.txt
docs/post_knowledge_guest_session_document_views-example.txt
+docs/post_knowledge_guest_session_documents_answers-example.txt
docs/post_knowledge_guest_session_documents_presentations-example.txt
docs/post_knowledge_guest_session_documents_search-example.txt
docs/post_knowledge_guest_session_documents_search_suggestions-example.txt
@@ -11454,6 +11561,7 @@ docs/post_knowledge_knowledgebase_document_variations-example.txt
docs/post_knowledge_knowledgebase_document_versions-example.txt
docs/post_knowledge_knowledgebase_document_views-example.txt
docs/post_knowledge_knowledgebase_documents-example.txt
+docs/post_knowledge_knowledgebase_documents_answers-example.txt
docs/post_knowledge_knowledgebase_documents_bulk_remove-example.txt
docs/post_knowledge_knowledgebase_documents_bulk_update-example.txt
docs/post_knowledge_knowledgebase_documents_presentations-example.txt
@@ -11815,6 +11923,8 @@ docs/put_architect_prompt_resource-example.txt
docs/put_architect_schedule-example.txt
docs/put_architect_schedulegroup-example.txt
docs/put_architect_systemprompt_resource-example.txt
+docs/put_assistant_copilot-example.txt
+docs/put_assistant_queue-example.txt
docs/put_authorization_division-example.txt
docs/put_authorization_division-example.txt
docs/put_authorization_role-example.txt
@@ -11851,6 +11961,7 @@ docs/put_externalcontacts_contact-example.txt
docs/put_externalcontacts_contact_note-example.txt
docs/put_externalcontacts_contacts_schema-example.txt
docs/put_externalcontacts_conversation-example.txt
+docs/put_externalcontacts_externalsource-example.txt
docs/put_externalcontacts_organization-example.txt
docs/put_externalcontacts_organization_note-example.txt
docs/put_externalcontacts_organization_trustor_trustor_id-example.txt
diff --git a/build/APIData.json b/build/APIData.json
index 8049ec2a3..e060dd697 100644
--- a/build/APIData.json
+++ b/build/APIData.json
@@ -1,4 +1,307 @@
{
+ "delete_assistant": {
+ "operationId": "delete_assistant",
+ "functionName": "delete_assistant",
+ "signature": "delete_assistant(assistant_id)",
+ "parameters": [
+ {
+ "name": "assistant_id",
+ "type": "str",
+ "required": "true"
+ }
+ ],
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.AgentAssistantsApi();\nassistant_id = 'assistant_id_example' # str | Assistant ID\n\ntry:\n # Delete an assistant.\n api_instance.delete_assistant(assistant_id)\nexcept ApiException as e:\n print(\"Exception when calling AgentAssistantsApi->delete_assistant: %s\\n\" % e)"
+ },
+ "delete_assistant_queue": {
+ "operationId": "delete_assistant_queue",
+ "functionName": "delete_assistant_queue",
+ "signature": "delete_assistant_queue(assistant_id, queue_id)",
+ "parameters": [
+ {
+ "name": "assistant_id",
+ "type": "str",
+ "required": "true"
+ },
+ {
+ "name": "queue_id",
+ "type": "str",
+ "required": "true"
+ }
+ ],
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.AgentAssistantsApi();\nassistant_id = 'assistant_id_example' # str | Assistant ID\nqueue_id = 'queue_id_example' # str | Queue ID\n\ntry:\n # Disassociate a queue from an assistant.\n api_instance.delete_assistant_queue(assistant_id, queue_id)\nexcept ApiException as e:\n print(\"Exception when calling AgentAssistantsApi->delete_assistant_queue: %s\\n\" % e)"
+ },
+ "delete_assistant_queues": {
+ "operationId": "delete_assistant_queues",
+ "functionName": "delete_assistant_queues",
+ "signature": "delete_assistant_queues(assistant_id, queue_ids)",
+ "parameters": [
+ {
+ "name": "assistant_id",
+ "type": "str",
+ "required": "true"
+ },
+ {
+ "name": "queue_ids",
+ "type": "str",
+ "required": "false"
+ }
+ ],
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.AgentAssistantsApi();\nassistant_id = 'assistant_id_example' # str | Assistant ID\nqueue_ids = 'queue_ids_example' # str | Comma-separated identifiers of the queues that need to be deleted. (optional)\n\ntry:\n # Disassociate the queues from an assistant for the given assistant ID and queue IDs.\n api_instance.delete_assistant_queues(assistant_id, queue_ids=queue_ids)\nexcept ApiException as e:\n print(\"Exception when calling AgentAssistantsApi->delete_assistant_queues: %s\\n\" % e)"
+ },
+ "get_assistant": {
+ "operationId": "get_assistant",
+ "functionName": "get_assistant",
+ "signature": "get_assistant(assistant_id, expand)",
+ "parameters": [
+ {
+ "name": "assistant_id",
+ "type": "str",
+ "required": "true"
+ },
+ {
+ "name": "expand",
+ "type": "str",
+ "required": "false"
+ }
+ ],
+ "return": "Assistant",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.AgentAssistantsApi();\nassistant_id = 'assistant_id_example' # str | Assistant ID\nexpand = 'expand_example' # str | Which fields, if any, to expand. (optional)\n\ntry:\n # Get an assistant.\n api_response = api_instance.get_assistant(assistant_id, expand=expand)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling AgentAssistantsApi->get_assistant: %s\\n\" % e)"
+ },
+ "get_assistant_queue": {
+ "operationId": "get_assistant_queue",
+ "functionName": "get_assistant_queue",
+ "signature": "get_assistant_queue(assistant_id, queue_id, expand)",
+ "parameters": [
+ {
+ "name": "assistant_id",
+ "type": "str",
+ "required": "true"
+ },
+ {
+ "name": "queue_id",
+ "type": "str",
+ "required": "true"
+ },
+ {
+ "name": "expand",
+ "type": "str",
+ "required": "false"
+ }
+ ],
+ "return": "AssistantQueue",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.AgentAssistantsApi();\nassistant_id = 'assistant_id_example' # str | Assistant ID\nqueue_id = 'queue_id_example' # str | Queue ID\nexpand = 'expand_example' # str | Which fields, if any, to expand. (optional)\n\ntry:\n # Get queue Information for an assistant.\n api_response = api_instance.get_assistant_queue(assistant_id, queue_id, expand=expand)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling AgentAssistantsApi->get_assistant_queue: %s\\n\" % e)"
+ },
+ "get_assistant_queues": {
+ "operationId": "get_assistant_queues",
+ "functionName": "get_assistant_queues",
+ "signature": "get_assistant_queues(assistant_id, before, after, page_size, expand)",
+ "parameters": [
+ {
+ "name": "assistant_id",
+ "type": "str",
+ "required": "true"
+ },
+ {
+ "name": "before",
+ "type": "str",
+ "required": "false"
+ },
+ {
+ "name": "after",
+ "type": "str",
+ "required": "false"
+ },
+ {
+ "name": "page_size",
+ "type": "str",
+ "required": "false"
+ },
+ {
+ "name": "expand",
+ "type": "str",
+ "required": "false"
+ }
+ ],
+ "return": "AssistantQueueListing",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.AgentAssistantsApi();\nassistant_id = 'assistant_id_example' # str | Assistant ID\nbefore = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional)\nafter = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional)\npage_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional)\nexpand = 'expand_example' # str | Which fields, if any, to expand. (optional)\n\ntry:\n # Get all the queues associated with an assistant.\n api_response = api_instance.get_assistant_queues(assistant_id, before=before, after=after, page_size=page_size, expand=expand)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling AgentAssistantsApi->get_assistant_queues: %s\\n\" % e)"
+ },
+ "get_assistants": {
+ "operationId": "get_assistants",
+ "functionName": "get_assistants",
+ "signature": "get_assistants(before, after, limit, page_size, name)",
+ "parameters": [
+ {
+ "name": "before",
+ "type": "str",
+ "required": "false"
+ },
+ {
+ "name": "after",
+ "type": "str",
+ "required": "false"
+ },
+ {
+ "name": "limit",
+ "type": "str",
+ "required": "false"
+ },
+ {
+ "name": "page_size",
+ "type": "str",
+ "required": "false"
+ },
+ {
+ "name": "name",
+ "type": "str",
+ "required": "false"
+ }
+ ],
+ "return": "AssistantListing",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.AgentAssistantsApi();\nbefore = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional)\nafter = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional)\nlimit = 'limit_example' # str | Number of entities to return. Maximum of 200. Deprecated in favour of pageSize (optional)\npage_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional)\nname = 'name_example' # str | Return the assistant by the given name. (optional)\n\ntry:\n # Get all assistants.\n api_response = api_instance.get_assistants(before=before, after=after, limit=limit, page_size=page_size, name=name)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling AgentAssistantsApi->get_assistants: %s\\n\" % e)"
+ },
+ "get_assistants_queues": {
+ "operationId": "get_assistants_queues",
+ "functionName": "get_assistants_queues",
+ "signature": "get_assistants_queues(before, after, page_size, queue_ids, expand)",
+ "parameters": [
+ {
+ "name": "before",
+ "type": "str",
+ "required": "false"
+ },
+ {
+ "name": "after",
+ "type": "str",
+ "required": "false"
+ },
+ {
+ "name": "page_size",
+ "type": "str",
+ "required": "false"
+ },
+ {
+ "name": "queue_ids",
+ "type": "str",
+ "required": "false"
+ },
+ {
+ "name": "expand",
+ "type": "str",
+ "required": "false"
+ }
+ ],
+ "return": "AssistantQueueListing",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.AgentAssistantsApi();\nbefore = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional)\nafter = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional)\npage_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional)\nqueue_ids = 'queue_ids_example' # str | Comma-separated identifiers of the queues that need to be retrieved. (optional)\nexpand = 'expand_example' # str | Which fields, if any, to expand. (optional)\n\ntry:\n # Get all queues assigned to any assistant.\n api_response = api_instance.get_assistants_queues(before=before, after=after, page_size=page_size, queue_ids=queue_ids, expand=expand)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling AgentAssistantsApi->get_assistants_queues: %s\\n\" % e)"
+ },
+ "patch_assistant": {
+ "operationId": "patch_assistant",
+ "functionName": "patch_assistant",
+ "signature": "patch_assistant(assistant_id, body)",
+ "parameters": [
+ {
+ "name": "assistant_id",
+ "type": "str",
+ "required": "true"
+ },
+ {
+ "name": "body",
+ "type": "Assistant",
+ "required": "true"
+ }
+ ],
+ "return": "Assistant",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.AgentAssistantsApi();\nassistant_id = 'assistant_id_example' # str | Assistant ID\nbody = PureCloudPlatformClientV2.Assistant() # Assistant | \n\ntry:\n # Update an assistant.\n api_response = api_instance.patch_assistant(assistant_id, body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling AgentAssistantsApi->patch_assistant: %s\\n\" % e)"
+ },
+ "patch_assistant_queues": {
+ "operationId": "patch_assistant_queues",
+ "functionName": "patch_assistant_queues",
+ "signature": "patch_assistant_queues(assistant_id, body)",
+ "parameters": [
+ {
+ "name": "assistant_id",
+ "type": "str",
+ "required": "true"
+ },
+ {
+ "name": "body",
+ "type": "list[AssistantQueue]",
+ "required": "true"
+ }
+ ],
+ "return": "AssistantQueueListing",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.AgentAssistantsApi();\nassistant_id = 'assistant_id_example' # str | Assistant ID\nbody = [PureCloudPlatformClientV2.AssistantQueue()] # list[AssistantQueue] | \n\ntry:\n # Update Queues for an Assistant.\n api_response = api_instance.patch_assistant_queues(assistant_id, body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling AgentAssistantsApi->patch_assistant_queues: %s\\n\" % e)"
+ },
+ "post_assistants": {
+ "operationId": "post_assistants",
+ "functionName": "post_assistants",
+ "signature": "post_assistants(body)",
+ "parameters": [
+ {
+ "name": "body",
+ "type": "Assistant",
+ "required": "true"
+ }
+ ],
+ "return": "Assistant",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.AgentAssistantsApi();\nbody = PureCloudPlatformClientV2.Assistant() # Assistant | \n\ntry:\n # Create an Assistant.\n api_response = api_instance.post_assistants(body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling AgentAssistantsApi->post_assistants: %s\\n\" % e)"
+ },
+ "put_assistant_queue": {
+ "operationId": "put_assistant_queue",
+ "functionName": "put_assistant_queue",
+ "signature": "put_assistant_queue(assistant_id, queue_id, body)",
+ "parameters": [
+ {
+ "name": "assistant_id",
+ "type": "str",
+ "required": "true"
+ },
+ {
+ "name": "queue_id",
+ "type": "str",
+ "required": "true"
+ },
+ {
+ "name": "body",
+ "type": "AssistantQueue",
+ "required": "true"
+ }
+ ],
+ "return": "AssistantQueue",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.AgentAssistantsApi();\nassistant_id = 'assistant_id_example' # str | Assistant ID\nqueue_id = 'queue_id_example' # str | Queue ID\nbody = PureCloudPlatformClientV2.AssistantQueue() # AssistantQueue | \n\ntry:\n # Create a queue assistant association.\n api_response = api_instance.put_assistant_queue(assistant_id, queue_id, body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling AgentAssistantsApi->put_assistant_queue: %s\\n\" % e)"
+ },
+ "get_assistant_copilot": {
+ "operationId": "get_assistant_copilot",
+ "functionName": "get_assistant_copilot",
+ "signature": "get_assistant_copilot(assistant_id)",
+ "parameters": [
+ {
+ "name": "assistant_id",
+ "type": "str",
+ "required": "true"
+ }
+ ],
+ "return": "Copilot",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.AgentCopilotApi();\nassistant_id = 'assistant_id_example' # str | Assistant ID\n\ntry:\n # Get copilot configuration of an assistant.\n api_response = api_instance.get_assistant_copilot(assistant_id)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling AgentCopilotApi->get_assistant_copilot: %s\\n\" % e)"
+ },
+ "put_assistant_copilot": {
+ "operationId": "put_assistant_copilot",
+ "functionName": "put_assistant_copilot",
+ "signature": "put_assistant_copilot(assistant_id, body)",
+ "parameters": [
+ {
+ "name": "assistant_id",
+ "type": "str",
+ "required": "true"
+ },
+ {
+ "name": "body",
+ "type": "Copilot",
+ "required": "true"
+ }
+ ],
+ "return": "Copilot",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.AgentCopilotApi();\nassistant_id = 'assistant_id_example' # str | Assistant ID\nbody = PureCloudPlatformClientV2.Copilot() # Copilot | \n\ntry:\n # Update agent copilot configuration\n api_response = api_instance.put_assistant_copilot(assistant_id, body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling AgentCopilotApi->put_assistant_copilot: %s\\n\" % e)"
+ },
"delete_users_agentui_agents_autoanswer_agent_id_settings": {
"operationId": "delete_users_agentui_agents_autoanswer_agent_id_settings",
"functionName": "delete_users_agentui_agents_autoanswer_agent_id_settings",
@@ -1056,7 +1359,7 @@
"get_analytics_reporting_settings_dashboards_query": {
"operationId": "get_analytics_reporting_settings_dashboards_query",
"functionName": "get_analytics_reporting_settings_dashboards_query",
- "signature": "get_analytics_reporting_settings_dashboards_query(dashboard_type, dashboard_access_filter, sort_by, page_number, page_size)",
+ "signature": "get_analytics_reporting_settings_dashboards_query(dashboard_type, dashboard_access_filter, name, sort_by, page_number, page_size)",
"parameters": [
{
"name": "dashboard_type",
@@ -1068,6 +1371,11 @@
"type": "str",
"required": "true"
},
+ {
+ "name": "name",
+ "type": "str",
+ "required": "false"
+ },
{
"name": "sort_by",
"type": "str",
@@ -1085,7 +1393,7 @@
}
],
"return": "DashboardConfigurationListing",
- "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.AnalyticsApi();\ndashboard_type = 'dashboard_type_example' # str | List dashboard of given type\ndashboard_access_filter = 'dashboard_access_filter_example' # str | Filter dashboard based on the owner of dashboard\nsort_by = ''desc'' # str | (optional) (default to 'desc')\npage_number = 1 # int | (optional) (default to 1)\npage_size = 9 # int | (optional) (default to 9)\n\ntry:\n # Get list of dashboard configurations\n api_response = api_instance.get_analytics_reporting_settings_dashboards_query(dashboard_type, dashboard_access_filter, sort_by=sort_by, page_number=page_number, page_size=page_size)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling AnalyticsApi->get_analytics_reporting_settings_dashboards_query: %s\\n\" % e)"
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.AnalyticsApi();\ndashboard_type = 'dashboard_type_example' # str | List dashboard of given type\ndashboard_access_filter = 'dashboard_access_filter_example' # str | Filter dashboard based on the owner of dashboard\nname = 'name_example' # str | name of the dashboard (optional)\nsort_by = ''desc'' # str | (optional) (default to 'desc')\npage_number = 1 # int | (optional) (default to 1)\npage_size = 9 # int | (optional) (default to 9)\n\ntry:\n # Get list of dashboard configurations\n api_response = api_instance.get_analytics_reporting_settings_dashboards_query(dashboard_type, dashboard_access_filter, name=name, sort_by=sort_by, page_number=page_number, page_size=page_size)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling AnalyticsApi->get_analytics_reporting_settings_dashboards_query: %s\\n\" % e)"
},
"get_analytics_reporting_settings_user_dashboards": {
"operationId": "get_analytics_reporting_settings_user_dashboards",
@@ -12964,6 +13272,20 @@
],
"example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.ExternalContactsApi();\nschema_id = 'schema_id_example' # str | Schema ID\n\ntry:\n # Delete a schema\n api_instance.delete_externalcontacts_contacts_schema(schema_id)\nexcept ApiException as e:\n print(\"Exception when calling ExternalContactsApi->delete_externalcontacts_contacts_schema: %s\\n\" % e)"
},
+ "delete_externalcontacts_externalsource": {
+ "operationId": "delete_externalcontacts_externalsource",
+ "functionName": "delete_externalcontacts_externalsource",
+ "signature": "delete_externalcontacts_externalsource(external_source_id)",
+ "parameters": [
+ {
+ "name": "external_source_id",
+ "type": "str",
+ "required": "true"
+ }
+ ],
+ "return": "object",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.ExternalContactsApi();\nexternal_source_id = 'external_source_id_example' # str | External Source ID\n\ntry:\n # 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.\n api_response = api_instance.delete_externalcontacts_externalsource(external_source_id)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling ExternalContactsApi->delete_externalcontacts_externalsource: %s\\n\" % e)"
+ },
"delete_externalcontacts_organization": {
"operationId": "delete_externalcontacts_organization",
"functionName": "delete_externalcontacts_organization",
@@ -13041,7 +13363,7 @@
}
],
"return": "ExternalContact",
- "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.ExternalContactsApi();\ncontact_id = 'contact_id_example' # str | ExternalContact ID\nexpand = ['expand_example'] # list[str] | which fields, if any, to expand (externalOrganization,externalDataSources,identifiers) (optional)\n\ntry:\n # Fetch an external contact\n api_response = api_instance.get_externalcontacts_contact(contact_id, expand=expand)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling ExternalContactsApi->get_externalcontacts_contact: %s\\n\" % e)"
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.ExternalContactsApi();\ncontact_id = 'contact_id_example' # str | ExternalContact ID\nexpand = ['expand_example'] # list[str] | which fields, if any, to expand (optional)\n\ntry:\n # Fetch an external contact\n api_response = api_instance.get_externalcontacts_contact(contact_id, expand=expand)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling ExternalContactsApi->get_externalcontacts_contact: %s\\n\" % e)"
},
"get_externalcontacts_contact_identifiers": {
"operationId": "get_externalcontacts_contact_identifiers",
@@ -13251,6 +13573,49 @@
"return": "DataSchemaListing",
"example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.ExternalContactsApi();\n\ntry:\n # Get a list of schemas.\n api_response = api_instance.get_externalcontacts_contacts_schemas()\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling ExternalContactsApi->get_externalcontacts_contacts_schemas: %s\\n\" % e)"
},
+ "get_externalcontacts_externalsource": {
+ "operationId": "get_externalcontacts_externalsource",
+ "functionName": "get_externalcontacts_externalsource",
+ "signature": "get_externalcontacts_externalsource(external_source_id)",
+ "parameters": [
+ {
+ "name": "external_source_id",
+ "type": "str",
+ "required": "true"
+ }
+ ],
+ "return": "ExternalSource",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.ExternalContactsApi();\nexternal_source_id = 'external_source_id_example' # str | External Source ID\n\ntry:\n # Fetch an External Source\n api_response = api_instance.get_externalcontacts_externalsource(external_source_id)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling ExternalContactsApi->get_externalcontacts_externalsource: %s\\n\" % e)"
+ },
+ "get_externalcontacts_externalsources": {
+ "operationId": "get_externalcontacts_externalsources",
+ "functionName": "get_externalcontacts_externalsources",
+ "signature": "get_externalcontacts_externalsources(cursor, limit, name, active)",
+ "parameters": [
+ {
+ "name": "cursor",
+ "type": "str",
+ "required": "false"
+ },
+ {
+ "name": "limit",
+ "type": "int",
+ "required": "false"
+ },
+ {
+ "name": "name",
+ "type": "str",
+ "required": "false"
+ },
+ {
+ "name": "active",
+ "type": "bool",
+ "required": "false"
+ }
+ ],
+ "return": "CursorExternalSourceListing",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.ExternalContactsApi();\ncursor = 'cursor_example' # str | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)\nlimit = 56 # int | The number of ExternalSources per page; must be between 10 and 200, default is 100 (optional)\nname = 'name_example' # str | Filter by external source name. Filtering is prefix filtering and not an exact match (optional)\nactive = True # bool | Filter by active status of external source (optional)\n\ntry:\n # Fetch a list of External Sources\n api_response = api_instance.get_externalcontacts_externalsources(cursor=cursor, limit=limit, name=name, active=active)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling ExternalContactsApi->get_externalcontacts_externalsources: %s\\n\" % e)"
+ },
"get_externalcontacts_organization": {
"operationId": "get_externalcontacts_organization",
"functionName": "get_externalcontacts_organization",
@@ -13936,6 +14301,20 @@
"return": "DataSchema",
"example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.ExternalContactsApi();\nbody = PureCloudPlatformClientV2.DataSchema() # DataSchema | Schema\n\ntry:\n # Create a schema\n api_response = api_instance.post_externalcontacts_contacts_schemas(body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling ExternalContactsApi->post_externalcontacts_contacts_schemas: %s\\n\" % e)"
},
+ "post_externalcontacts_externalsources": {
+ "operationId": "post_externalcontacts_externalsources",
+ "functionName": "post_externalcontacts_externalsources",
+ "signature": "post_externalcontacts_externalsources(body)",
+ "parameters": [
+ {
+ "name": "body",
+ "type": "ExternalSource",
+ "required": "true"
+ }
+ ],
+ "return": "ExternalSource",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.ExternalContactsApi();\nbody = PureCloudPlatformClientV2.ExternalSource() # ExternalSource | External Source\n\ntry:\n # Create an External Source\n api_response = api_instance.post_externalcontacts_externalsources(body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling ExternalContactsApi->post_externalcontacts_externalsources: %s\\n\" % e)"
+ },
"post_externalcontacts_identifierlookup": {
"operationId": "post_externalcontacts_identifierlookup",
"functionName": "post_externalcontacts_identifierlookup",
@@ -14110,6 +14489,25 @@
],
"example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.ExternalContactsApi();\nconversation_id = 'conversation_id_example' # str | Conversation ID\nbody = PureCloudPlatformClientV2.ConversationAssociation() # ConversationAssociation | ConversationAssociation\n\ntry:\n # Associate/disassociate an external contact with a conversation\n api_instance.put_externalcontacts_conversation(conversation_id, body)\nexcept ApiException as e:\n print(\"Exception when calling ExternalContactsApi->put_externalcontacts_conversation: %s\\n\" % e)"
},
+ "put_externalcontacts_externalsource": {
+ "operationId": "put_externalcontacts_externalsource",
+ "functionName": "put_externalcontacts_externalsource",
+ "signature": "put_externalcontacts_externalsource(external_source_id, body)",
+ "parameters": [
+ {
+ "name": "external_source_id",
+ "type": "str",
+ "required": "true"
+ },
+ {
+ "name": "body",
+ "type": "ExternalSource",
+ "required": "true"
+ }
+ ],
+ "return": "ExternalSource",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.ExternalContactsApi();\nexternal_source_id = 'external_source_id_example' # str | External Source ID\nbody = PureCloudPlatformClientV2.ExternalSource() # ExternalSource | External Source\n\ntry:\n # Update an External Source\n api_response = api_instance.put_externalcontacts_externalsource(external_source_id, body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling ExternalContactsApi->put_externalcontacts_externalsource: %s\\n\" % e)"
+ },
"put_externalcontacts_organization": {
"operationId": "put_externalcontacts_organization",
"functionName": "put_externalcontacts_organization",
@@ -19523,7 +19921,7 @@
"get_journey_views": {
"operationId": "get_journey_views",
"functionName": "get_journey_views",
- "signature": "get_journey_views(page_number, page_size, name_or_created_by, expand)",
+ "signature": "get_journey_views(page_number, page_size, name_or_created_by, expand, id)",
"parameters": [
{
"name": "page_number",
@@ -19544,10 +19942,15 @@
"name": "expand",
"type": "str",
"required": "false"
+ },
+ {
+ "name": "id",
+ "type": "str",
+ "required": "false"
}
],
"return": "JourneyViewListing",
- "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.JourneyApi();\npage_number = 1 # int | Page number (optional) (default to 1)\npage_size = 25 # int | Page size (optional) (default to 25)\nname_or_created_by = 'name_or_created_by_example' # str | Journey View Name or Created By (optional)\nexpand = 'expand_example' # str | Parameter to request additional data to return in Journey payload (optional)\n\ntry:\n # Get a list of Journey Views\n api_response = api_instance.get_journey_views(page_number=page_number, page_size=page_size, name_or_created_by=name_or_created_by, expand=expand)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling JourneyApi->get_journey_views: %s\\n\" % e)"
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.JourneyApi();\npage_number = 1 # int | Page number (optional) (default to 1)\npage_size = 25 # int | Page size (optional) (default to 25)\nname_or_created_by = 'name_or_created_by_example' # str | Journey View Name or Created By (optional)\nexpand = 'expand_example' # str | Parameter to request additional data to return in Journey payload (optional)\nid = 'id_example' # str | Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items. (optional)\n\ntry:\n # Get a list of Journey Views\n api_response = api_instance.get_journey_views(page_number=page_number, page_size=page_size, name_or_created_by=name_or_created_by, expand=expand, id=id)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling JourneyApi->get_journey_views: %s\\n\" % e)"
},
"get_journey_views_eventdefinition": {
"operationId": "get_journey_views_eventdefinition",
@@ -21457,6 +21860,35 @@
"return": "KnowledgeDocumentResponse",
"example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.KnowledgeApi();\nknowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID.\ndocument_id = 'document_id_example' # str | Document ID.\nbody = PureCloudPlatformClientV2.KnowledgeDocumentReq() # KnowledgeDocumentReq | \n\ntry:\n # Update document.\n api_response = api_instance.patch_knowledge_knowledgebase_document(knowledge_base_id, document_id, body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling KnowledgeApi->patch_knowledge_knowledgebase_document: %s\\n\" % e)"
},
+ "patch_knowledge_knowledgebase_document_feedback_feedback_id": {
+ "operationId": "patch_knowledge_knowledgebase_document_feedback_feedback_id",
+ "functionName": "patch_knowledge_knowledgebase_document_feedback_feedback_id",
+ "signature": "patch_knowledge_knowledgebase_document_feedback_feedback_id(knowledge_base_id, document_id, feedback_id, body)",
+ "parameters": [
+ {
+ "name": "knowledge_base_id",
+ "type": "str",
+ "required": "true"
+ },
+ {
+ "name": "document_id",
+ "type": "str",
+ "required": "true"
+ },
+ {
+ "name": "feedback_id",
+ "type": "str",
+ "required": "true"
+ },
+ {
+ "name": "body",
+ "type": "KnowledgeDocumentFeedbackUpdateRequest",
+ "required": "false"
+ }
+ ],
+ "return": "KnowledgeDocumentFeedbackResponse",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.KnowledgeApi();\nknowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID.\ndocument_id = 'document_id_example' # str | Document ID.\nfeedback_id = 'feedback_id_example' # str | Feedback ID.\nbody = PureCloudPlatformClientV2.KnowledgeDocumentFeedbackUpdateRequest() # KnowledgeDocumentFeedbackUpdateRequest | (optional)\n\ntry:\n # Update feedback on a document\n api_response = api_instance.patch_knowledge_knowledgebase_document_feedback_feedback_id(knowledge_base_id, document_id, feedback_id, body=body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling KnowledgeApi->patch_knowledge_knowledgebase_document_feedback_feedback_id: %s\\n\" % e)"
+ },
"patch_knowledge_knowledgebase_document_variation": {
"operationId": "patch_knowledge_knowledgebase_document_variation",
"functionName": "patch_knowledge_knowledgebase_document_variation",
@@ -21804,6 +22236,25 @@
],
"example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.KnowledgeApi();\nsession_id = 'session_id_example' # str | Knowledge guest session ID.\ndocument_id = 'document_id_example' # str | Document ID\nbody = PureCloudPlatformClientV2.KnowledgeGuestDocumentView() # KnowledgeGuestDocumentView | (optional)\n\ntry:\n # Create view event for a document.\n api_instance.post_knowledge_guest_session_document_views(session_id, document_id, body=body)\nexcept ApiException as e:\n print(\"Exception when calling KnowledgeApi->post_knowledge_guest_session_document_views: %s\\n\" % e)"
},
+ "post_knowledge_guest_session_documents_answers": {
+ "operationId": "post_knowledge_guest_session_documents_answers",
+ "functionName": "post_knowledge_guest_session_documents_answers",
+ "signature": "post_knowledge_guest_session_documents_answers(session_id, body)",
+ "parameters": [
+ {
+ "name": "session_id",
+ "type": "str",
+ "required": "true"
+ },
+ {
+ "name": "body",
+ "type": "KnowledgeDocumentsAnswerFilter",
+ "required": "true"
+ }
+ ],
+ "return": "KnowledgeGuestAnswerDocumentsResponse",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.KnowledgeApi();\nsession_id = 'session_id_example' # str | Knowledge guest session ID.\nbody = PureCloudPlatformClientV2.KnowledgeDocumentsAnswerFilter() # KnowledgeDocumentsAnswerFilter | \n\ntry:\n # Answer documents.\n api_response = api_instance.post_knowledge_guest_session_documents_answers(session_id, body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling KnowledgeApi->post_knowledge_guest_session_documents_answers: %s\\n\" % e)"
+ },
"post_knowledge_guest_session_documents_presentations": {
"operationId": "post_knowledge_guest_session_documents_presentations",
"functionName": "post_knowledge_guest_session_documents_presentations",
@@ -22035,6 +22486,25 @@
"return": "KnowledgeDocumentResponse",
"example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.KnowledgeApi();\nknowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID\nbody = PureCloudPlatformClientV2.KnowledgeDocumentReq() # KnowledgeDocumentReq | \n\ntry:\n # Create document.\n api_response = api_instance.post_knowledge_knowledgebase_documents(knowledge_base_id, body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling KnowledgeApi->post_knowledge_knowledgebase_documents: %s\\n\" % e)"
},
+ "post_knowledge_knowledgebase_documents_answers": {
+ "operationId": "post_knowledge_knowledgebase_documents_answers",
+ "functionName": "post_knowledge_knowledgebase_documents_answers",
+ "signature": "post_knowledge_knowledgebase_documents_answers(knowledge_base_id, body)",
+ "parameters": [
+ {
+ "name": "knowledge_base_id",
+ "type": "str",
+ "required": "true"
+ },
+ {
+ "name": "body",
+ "type": "KnowledgeDocumentsAnswerFilter",
+ "required": "true"
+ }
+ ],
+ "return": "KnowledgeAnswerDocumentsResponse",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.KnowledgeApi();\nknowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID\nbody = PureCloudPlatformClientV2.KnowledgeDocumentsAnswerFilter() # KnowledgeDocumentsAnswerFilter | \n\ntry:\n # Answer documents.\n api_response = api_instance.post_knowledge_knowledgebase_documents_answers(knowledge_base_id, body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling KnowledgeApi->post_knowledge_knowledgebase_documents_answers: %s\\n\" % e)"
+ },
"post_knowledge_knowledgebase_documents_bulk_remove": {
"operationId": "post_knowledge_knowledgebase_documents_bulk_remove",
"functionName": "post_knowledge_knowledgebase_documents_bulk_remove",
@@ -33780,6 +34250,25 @@
"return": "Queue",
"example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.RoutingApi();\nqueue_id = 'queue_id_example' # str | Queue ID\n\ntry:\n # Get details about this queue.\n api_response = api_instance.get_routing_queue(queue_id)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling RoutingApi->get_routing_queue: %s\\n\" % e)"
},
+ "get_routing_queue_assistant": {
+ "operationId": "get_routing_queue_assistant",
+ "functionName": "get_routing_queue_assistant",
+ "signature": "get_routing_queue_assistant(queue_id, expand)",
+ "parameters": [
+ {
+ "name": "queue_id",
+ "type": "str",
+ "required": "true"
+ },
+ {
+ "name": "expand",
+ "type": "str",
+ "required": "false"
+ }
+ ],
+ "return": "AssistantQueue",
+ "example": "import PureCloudPlatformClientV2\nfrom PureCloudPlatformClientV2.rest import ApiException\nfrom pprint import pprint\n\n# Configure OAuth2 access token for authorization: PureCloud OAuth\nPureCloudPlatformClientV2.configuration.access_token = 'your_access_token'\n# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)\n\n# create an instance of the API class\napi_instance = PureCloudPlatformClientV2.RoutingApi();\nqueue_id = 'queue_id_example' # str | Queue ID\nexpand = 'expand_example' # str | Which fields, if any, to expand. (optional)\n\ntry:\n # Get an assistant associated with a queue.\n api_response = api_instance.get_routing_queue_assistant(queue_id, expand=expand)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling RoutingApi->get_routing_queue_assistant: %s\\n\" % e)"
+ },
"get_routing_queue_comparisonperiod": {
"operationId": "get_routing_queue_comparisonperiod",
"functionName": "get_routing_queue_comparisonperiod",
diff --git a/build/PureCloudPlatformClientV2/__init__.py b/build/PureCloudPlatformClientV2/__init__.py
index 172d33a2e..37c9a1e6c 100644
--- a/build/PureCloudPlatformClientV2/__init__.py
+++ b/build/PureCloudPlatformClientV2/__init__.py
@@ -220,6 +220,7 @@
from .models.analytics_user_details_query_response import AnalyticsUserDetailsQueryResponse
from .models.analytics_user_presence_record import AnalyticsUserPresenceRecord
from .models.annotation import Annotation
+from .models.answer_generation_config import AnswerGenerationConfig
from .models.answer_generation_document import AnswerGenerationDocument
from .models.answer_option import AnswerOption
from .models.api_usage_client_query import ApiUsageClientQuery
@@ -286,6 +287,10 @@
from .models.assignment_error import AssignmentError
from .models.assignment_validation import AssignmentValidation
from .models.assistance_condition import AssistanceCondition
+from .models.assistant import Assistant
+from .models.assistant_listing import AssistantListing
+from .models.assistant_queue import AssistantQueue
+from .models.assistant_queue_listing import AssistantQueueListing
from .models.associated_value_field import AssociatedValueField
from .models.async_conversation_query import AsyncConversationQuery
from .models.async_forecast_operation_result import AsyncForecastOperationResult
@@ -398,6 +403,8 @@
from .models.bot_version_summary import BotVersionSummary
from .models.browser import Browser
from .models.bu_abandon_rate import BuAbandonRate
+from .models.bu_activity_settings_request import BuActivitySettingsRequest
+from .models.bu_activity_settings_response import BuActivitySettingsResponse
from .models.bu_agent_schedule_activity import BuAgentScheduleActivity
from .models.bu_agent_schedule_history_change import BuAgentScheduleHistoryChange
from .models.bu_agent_schedule_history_change_metadata import BuAgentScheduleHistoryChangeMetadata
@@ -444,6 +451,8 @@
from .models.bu_intraday_schedule_data import BuIntradayScheduleData
from .models.bu_list_alternative_shift_trades_response import BuListAlternativeShiftTradesResponse
from .models.bu_management_unit_schedule_summary import BuManagementUnitScheduleSummary
+from .models.bu_notification_settings_request import BuNotificationSettingsRequest
+from .models.bu_notification_settings_response import BuNotificationSettingsResponse
from .models.bu_planning_group_headcount_forecast import BuPlanningGroupHeadcountForecast
from .models.bu_query_adherence_explanations_request import BuQueryAdherenceExplanationsRequest
from .models.bu_query_adherence_explanations_response import BuQueryAdherenceExplanationsResponse
@@ -454,6 +463,9 @@
from .models.bu_schedule_list_item import BuScheduleListItem
from .models.bu_schedule_listing import BuScheduleListing
from .models.bu_schedule_metadata import BuScheduleMetadata
+from .models.bu_schedule_notifications_category_settings import BuScheduleNotificationsCategorySettings
+from .models.bu_schedule_notifications_settings_request import BuScheduleNotificationsSettingsRequest
+from .models.bu_schedule_notifications_settings_response import BuScheduleNotificationsSettingsResponse
from .models.bu_schedule_reference import BuScheduleReference
from .models.bu_schedule_reference_for_mu_route import BuScheduleReferenceForMuRoute
from .models.bu_schedule_run import BuScheduleRun
@@ -590,6 +602,7 @@
from .models.campaign_rule_action import CampaignRuleAction
from .models.campaign_rule_action_entities import CampaignRuleActionEntities
from .models.campaign_rule_condition import CampaignRuleCondition
+from .models.campaign_rule_condition_group import CampaignRuleConditionGroup
from .models.campaign_rule_entities import CampaignRuleEntities
from .models.campaign_rule_entity_listing import CampaignRuleEntityListing
from .models.campaign_rule_parameters import CampaignRuleParameters
@@ -1004,6 +1017,7 @@
from .models.conversation_notification_template_parameter import ConversationNotificationTemplateParameter
from .models.conversation_participant_search_criteria import ConversationParticipantSearchCriteria
from .models.conversation_participant_search_request import ConversationParticipantSearchRequest
+from .models.conversation_profile import ConversationProfile
from .models.conversation_properties import ConversationProperties
from .models.conversation_public_metadata import ConversationPublicMetadata
from .models.conversation_query import ConversationQuery
@@ -1061,6 +1075,13 @@
from .models.conversation_video_event_topic_video_conversation import ConversationVideoEventTopicVideoConversation
from .models.conversation_video_event_topic_video_media_participant import ConversationVideoEventTopicVideoMediaParticipant
from .models.conversation_video_event_topic_wrapup import ConversationVideoEventTopicWrapup
+from .models.copilot import Copilot
+from .models.copilot_action import CopilotAction
+from .models.copilot_condition import CopilotCondition
+from .models.copilot_fallback_action import CopilotFallbackAction
+from .models.copilot_nlu_domain import CopilotNluDomain
+from .models.copilot_nlu_domain_version import CopilotNluDomainVersion
+from .models.copilot_rule import CopilotRule
from .models.copy_attachments_request import CopyAttachmentsRequest
from .models.copy_bu_forecast_request import CopyBuForecastRequest
from .models.copy_voicemail_message import CopyVoicemailMessage
@@ -1151,6 +1172,7 @@
from .models.current_user_schedule_request_body import CurrentUserScheduleRequestBody
from .models.current_user_time_off_integration_status_request import CurrentUserTimeOffIntegrationStatusRequest
from .models.cursor_contact_listing import CursorContactListing
+from .models.cursor_external_source_listing import CursorExternalSourceListing
from .models.cursor_note_listing import CursorNoteListing
from .models.cursor_organization_listing import CursorOrganizationListing
from .models.cursor_relationship_listing import CursorRelationshipListing
@@ -1734,6 +1756,7 @@
from .models.facet_term import FacetTerm
from .models.failed_object import FailedObject
from .models.failed_recording_entity_listing import FailedRecordingEntityListing
+from .models.fallback import Fallback
from .models.faq import Faq
from .models.fax_config import FaxConfig
from .models.fax_document import FaxDocument
@@ -1903,6 +1926,7 @@
from .models.get_rules_query import GetRulesQuery
from .models.get_templates_response import GetTemplatesResponse
from .models.get_upload_source_url_job_status_response import GetUploadSourceUrlJobStatusResponse
+from .models.google_dialogflow_config import GoogleDialogflowConfig
from .models.google_dialogflow_custom_settings import GoogleDialogflowCustomSettings
from .models.grammar import Grammar
from .models.grammar_file_upload_request import GrammarFileUploadRequest
@@ -2218,6 +2242,9 @@
from .models.knowledge_aggregate_query_response import KnowledgeAggregateQueryResponse
from .models.knowledge_aggregation_query import KnowledgeAggregationQuery
from .models.knowledge_aggregation_view import KnowledgeAggregationView
+from .models.knowledge_answer_config import KnowledgeAnswerConfig
+from .models.knowledge_answer_document_response import KnowledgeAnswerDocumentResponse
+from .models.knowledge_answer_documents_response import KnowledgeAnswerDocumentsResponse
from .models.knowledge_answer_generation_response import KnowledgeAnswerGenerationResponse
from .models.knowledge_async_aggregate_query_response import KnowledgeAsyncAggregateQueryResponse
from .models.knowledge_async_aggregation_query import KnowledgeAsyncAggregationQuery
@@ -2226,6 +2253,7 @@
from .models.knowledge_base_listing import KnowledgeBaseListing
from .models.knowledge_base_reference import KnowledgeBaseReference
from .models.knowledge_base_update_request import KnowledgeBaseUpdateRequest
+from .models.knowledge_base_with_dialect_reference import KnowledgeBaseWithDialectReference
from .models.knowledge_category import KnowledgeCategory
from .models.knowledge_category_request import KnowledgeCategoryRequest
from .models.knowledge_context_reference import KnowledgeContextReference
@@ -2245,6 +2273,7 @@
from .models.knowledge_document_feedback import KnowledgeDocumentFeedback
from .models.knowledge_document_feedback_response import KnowledgeDocumentFeedbackResponse
from .models.knowledge_document_feedback_response_listing import KnowledgeDocumentFeedbackResponseListing
+from .models.knowledge_document_feedback_update_request import KnowledgeDocumentFeedbackUpdateRequest
from .models.knowledge_document_guest_search import KnowledgeDocumentGuestSearch
from .models.knowledge_document_guest_search_request import KnowledgeDocumentGuestSearchRequest
from .models.knowledge_document_guest_search_result import KnowledgeDocumentGuestSearchResult
@@ -2270,12 +2299,15 @@
from .models.knowledge_document_version_variation_listing import KnowledgeDocumentVersionVariationListing
from .models.knowledge_document_version_variation_reference import KnowledgeDocumentVersionVariationReference
from .models.knowledge_document_view import KnowledgeDocumentView
+from .models.knowledge_documents_answer_filter import KnowledgeDocumentsAnswerFilter
from .models.knowledge_export_job_documents_filter import KnowledgeExportJobDocumentsFilter
from .models.knowledge_export_job_filter import KnowledgeExportJobFilter
from .models.knowledge_export_job_request import KnowledgeExportJobRequest
from .models.knowledge_export_job_response import KnowledgeExportJobResponse
from .models.knowledge_extended_category import KnowledgeExtendedCategory
from .models.knowledge_group_statistics import KnowledgeGroupStatistics
+from .models.knowledge_guest_answer_document_response import KnowledgeGuestAnswerDocumentResponse
+from .models.knowledge_guest_answer_documents_response import KnowledgeGuestAnswerDocumentsResponse
from .models.knowledge_guest_document_copy import KnowledgeGuestDocumentCopy
from .models.knowledge_guest_document_feedback import KnowledgeGuestDocumentFeedback
from .models.knowledge_guest_document_presentation import KnowledgeGuestDocumentPresentation
@@ -2313,6 +2345,7 @@
from .models.knowledge_search_document_v1 import KnowledgeSearchDocumentV1
from .models.knowledge_search_request import KnowledgeSearchRequest
from .models.knowledge_search_response import KnowledgeSearchResponse
+from .models.knowledge_suggestion_config import KnowledgeSuggestionConfig
from .models.knowledge_training import KnowledgeTraining
from .models.kpi_result import KpiResult
from .models.label import Label
@@ -2632,6 +2665,7 @@
from .models.namespace_docs import NamespaceDocs
from .models.network_connectivity import NetworkConnectivity
from .models.next_occurrence_details import NextOccurrenceDetails
+from .models.nlu_config import NluConfig
from .models.nlu_confusion_matrix_column import NluConfusionMatrixColumn
from .models.nlu_confusion_matrix_row import NluConfusionMatrixRow
from .models.nlu_detection_context import NluDetectionContext
@@ -3417,6 +3451,8 @@
from .models.routing_status_detail_query_filter import RoutingStatusDetailQueryFilter
from .models.routing_status_detail_query_predicate import RoutingStatusDetailQueryPredicate
from .models.routing_transfer_event import RoutingTransferEvent
+from .models.rule_config import RuleConfig
+from .models.rule_engine_config import RuleEngineConfig
from .models.rule_set import RuleSet
from .models.rule_set_diagnostic import RuleSetDiagnostic
from .models.rule_set_entity_listing import RuleSetEntityListing
@@ -3669,6 +3705,7 @@
from .models.suggestion_knowledge_search import SuggestionKnowledgeSearch
from .models.suggestion_listing import SuggestionListing
from .models.suggestion_script import SuggestionScript
+from .models.summary_generation_config import SummaryGenerationConfig
from .models.support_center_category import SupportCenterCategory
from .models.support_center_compact_category_module_template import SupportCenterCompactCategoryModuleTemplate
from .models.support_center_custom_message import SupportCenterCustomMessage
@@ -3855,6 +3892,7 @@
from .models.transcript_topics import TranscriptTopics
from .models.transcript_url import TranscriptUrl
from .models.transcript_urls import TranscriptUrls
+from .models.transcription_config import TranscriptionConfig
from .models.transcription_engines_request import TranscriptionEnginesRequest
from .models.transcription_settings import TranscriptionSettings
from .models.transcription_topic_transcript_alternative import TranscriptionTopicTranscriptAlternative
@@ -4517,6 +4555,7 @@
from .models.workitem_create import WorkitemCreate
from .models.workitem_delta import WorkitemDelta
from .models.workitem_filter import WorkitemFilter
+from .models.workitem_flow_reference import WorkitemFlowReference
from .models.workitem_manual_assign import WorkitemManualAssign
from .models.workitem_paged_entity_listing import WorkitemPagedEntityListing
from .models.workitem_post_query_entity_listing import WorkitemPostQueryEntityListing
@@ -4529,6 +4568,7 @@
from .models.workitem_query_sort import WorkitemQuerySort
from .models.workitem_queue_reference import WorkitemQueueReference
from .models.workitem_reference import WorkitemReference
+from .models.workitem_rule_settings import WorkitemRuleSettings
from .models.workitem_schema import WorkitemSchema
from .models.workitem_scored_agent import WorkitemScoredAgent
from .models.workitem_scored_agent_request import WorkitemScoredAgentRequest
@@ -4596,6 +4636,7 @@
from .models.wrapup import Wrapup
from .models.wrapup_code import WrapupCode
from .models.wrapup_code_entity_listing import WrapupCodeEntityListing
+from .models.wrapup_code_prediction_config import WrapupCodePredictionConfig
from .models.wrapup_code_request import WrapupCodeRequest
from .models.wrapup_detail_event_topic_wrapup_event import WrapupDetailEventTopicWrapupEvent
from .models.wrapup_id_reference import WrapupIdReference
@@ -4606,6 +4647,8 @@
from .models.writable_starrable_division import WritableStarrableDivision
# import apis into sdk package
+from .apis.agent_assistants_api import AgentAssistantsApi
+from .apis.agent_copilot_api import AgentCopilotApi
from .apis.agent_ui_api import AgentUIApi
from .apis.alerting_api import AlertingApi
from .apis.analytics_api import AnalyticsApi
@@ -4682,6 +4725,8 @@
from .apis.web_deployments_api import WebDeploymentsApi
from .apis.widgets_api import WidgetsApi
from .apis.workforce_management_api import WorkforceManagementApi
+from .apis.agent_assistants_api import AgentAssistantsApi
+from .apis.agent_copilot_api import AgentCopilotApi
from .apis.agent_ui_api import AgentUIApi
from .apis.alerting_api import AlertingApi
from .apis.analytics_api import AnalyticsApi
diff --git a/build/PureCloudPlatformClientV2/api_client.py b/build/PureCloudPlatformClientV2/api_client.py
index d9bc7d366..73681044c 100644
--- a/build/PureCloudPlatformClientV2/api_client.py
+++ b/build/PureCloudPlatformClientV2/api_client.py
@@ -357,7 +357,7 @@ def __call_api(self, resource_path, method,
header_params['Cookie'] = self.cookie
if header_params:
header_params = self.sanitize_for_serialization(header_params)
- header_params['purecloud-sdk'] = '210.0.0'
+ header_params['purecloud-sdk'] = '211.0.0'
# path parameters
if path_params:
diff --git a/build/PureCloudPlatformClientV2/apis/__init__.py b/build/PureCloudPlatformClientV2/apis/__init__.py
index ef0d41d60..f26ac22b0 100644
--- a/build/PureCloudPlatformClientV2/apis/__init__.py
+++ b/build/PureCloudPlatformClientV2/apis/__init__.py
@@ -1,6 +1,8 @@
from __future__ import absolute_import
# import apis into api package
+from .agent_assistants_api import AgentAssistantsApi
+from .agent_copilot_api import AgentCopilotApi
from .agent_ui_api import AgentUIApi
from .alerting_api import AlertingApi
from .analytics_api import AnalyticsApi
@@ -77,6 +79,8 @@
from .web_deployments_api import WebDeploymentsApi
from .widgets_api import WidgetsApi
from .workforce_management_api import WorkforceManagementApi
+from .agent_assistants_api import AgentAssistantsApi
+from .agent_copilot_api import AgentCopilotApi
from .agent_ui_api import AgentUIApi
from .alerting_api import AlertingApi
from .analytics_api import AnalyticsApi
diff --git a/build/PureCloudPlatformClientV2/apis/agent_assistants_api.py b/build/PureCloudPlatformClientV2/apis/agent_assistants_api.py
new file mode 100644
index 000000000..b4d498ee6
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/apis/agent_assistants_api.py
@@ -0,0 +1,1072 @@
+# coding: utf-8
+
+"""
+AgentAssistantsApi.py
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+"""
+
+from __future__ import absolute_import
+
+import sys
+import os
+import re
+
+from datetime import datetime
+from datetime import date
+
+# python 2 and python 3 compatibility library
+from six import iteritems
+
+from ..configuration import Configuration
+from ..api_client import ApiClient
+from ..utils import deprecated
+
+from typing import List
+from typing import Dict
+from typing import Any
+
+from ..models import Empty
+from ..models import Assistant
+from ..models import AssistantListing
+from ..models import AssistantQueue
+from ..models import AssistantQueueListing
+from ..models import ErrorBody
+
+class AgentAssistantsApi(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ Ref: https://github.com/swagger-api/swagger-codegen
+ """
+
+ def __init__(self, api_client=None):
+ config = Configuration()
+ if api_client:
+ self.api_client = api_client
+ else:
+ if not config.api_client:
+ config.api_client = ApiClient()
+ self.api_client = config.api_client
+
+ def delete_assistant(self, assistant_id: str, **kwargs) -> None:
+ """
+ Delete an assistant.
+
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.delete_assistant(assistant_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str assistant_id: Assistant ID (required)
+ :return: None
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['assistant_id']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method delete_assistant" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'assistant_id' is set
+ if ('assistant_id' not in params) or (params['assistant_id'] is None):
+ raise ValueError("Missing the required parameter `assistant_id` when calling `delete_assistant`")
+
+
+ resource_path = '/api/v2/assistants/{assistantId}'.replace('{format}', 'json')
+ path_params = {}
+ if 'assistant_id' in params:
+ path_params['assistantId'] = params['assistant_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'DELETE',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type=None,
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
+ def delete_assistant_queue(self, assistant_id: str, queue_id: str, **kwargs) -> None:
+ """
+ Disassociate a queue from an assistant.
+
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.delete_assistant_queue(assistant_id, queue_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str assistant_id: Assistant ID (required)
+ :param str queue_id: Queue ID (required)
+ :return: None
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['assistant_id', 'queue_id']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method delete_assistant_queue" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'assistant_id' is set
+ if ('assistant_id' not in params) or (params['assistant_id'] is None):
+ raise ValueError("Missing the required parameter `assistant_id` when calling `delete_assistant_queue`")
+ # verify the required parameter 'queue_id' is set
+ if ('queue_id' not in params) or (params['queue_id'] is None):
+ raise ValueError("Missing the required parameter `queue_id` when calling `delete_assistant_queue`")
+
+
+ resource_path = '/api/v2/assistants/{assistantId}/queues/{queueId}'.replace('{format}', 'json')
+ path_params = {}
+ if 'assistant_id' in params:
+ path_params['assistantId'] = params['assistant_id']
+ if 'queue_id' in params:
+ path_params['queueId'] = params['queue_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'DELETE',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type=None,
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
+ def delete_assistant_queues(self, assistant_id: str, **kwargs) -> None:
+ """
+ Disassociate the queues from an assistant for the given assistant ID and queue IDs.
+
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.delete_assistant_queues(assistant_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str assistant_id: Assistant ID (required)
+ :param str queue_ids: Comma-separated identifiers of the queues that need to be deleted.
+ :return: None
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['assistant_id', 'queue_ids']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method delete_assistant_queues" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'assistant_id' is set
+ if ('assistant_id' not in params) or (params['assistant_id'] is None):
+ raise ValueError("Missing the required parameter `assistant_id` when calling `delete_assistant_queues`")
+
+
+ resource_path = '/api/v2/assistants/{assistantId}/queues'.replace('{format}', 'json')
+ path_params = {}
+ if 'assistant_id' in params:
+ path_params['assistantId'] = params['assistant_id']
+
+ query_params = {}
+ if 'queue_ids' in params:
+ query_params['queueIds'] = params['queue_ids']
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'DELETE',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type=None,
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
+ def get_assistant(self, assistant_id: str, **kwargs) -> 'Assistant':
+ """
+ Get an assistant.
+
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_assistant(assistant_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str assistant_id: Assistant ID (required)
+ :param str expand: Which fields, if any, to expand.
+ :return: Assistant
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['assistant_id', 'expand']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method get_assistant" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'assistant_id' is set
+ if ('assistant_id' not in params) or (params['assistant_id'] is None):
+ raise ValueError("Missing the required parameter `assistant_id` when calling `get_assistant`")
+
+
+ resource_path = '/api/v2/assistants/{assistantId}'.replace('{format}', 'json')
+ path_params = {}
+ if 'assistant_id' in params:
+ path_params['assistantId'] = params['assistant_id']
+
+ query_params = {}
+ if 'expand' in params:
+ query_params['expand'] = params['expand']
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='Assistant',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
+ def get_assistant_queue(self, assistant_id: str, queue_id: str, **kwargs) -> 'AssistantQueue':
+ """
+ Get queue Information for an assistant.
+
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_assistant_queue(assistant_id, queue_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str assistant_id: Assistant ID (required)
+ :param str queue_id: Queue ID (required)
+ :param str expand: Which fields, if any, to expand.
+ :return: AssistantQueue
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['assistant_id', 'queue_id', 'expand']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method get_assistant_queue" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'assistant_id' is set
+ if ('assistant_id' not in params) or (params['assistant_id'] is None):
+ raise ValueError("Missing the required parameter `assistant_id` when calling `get_assistant_queue`")
+ # verify the required parameter 'queue_id' is set
+ if ('queue_id' not in params) or (params['queue_id'] is None):
+ raise ValueError("Missing the required parameter `queue_id` when calling `get_assistant_queue`")
+
+
+ resource_path = '/api/v2/assistants/{assistantId}/queues/{queueId}'.replace('{format}', 'json')
+ path_params = {}
+ if 'assistant_id' in params:
+ path_params['assistantId'] = params['assistant_id']
+ if 'queue_id' in params:
+ path_params['queueId'] = params['queue_id']
+
+ query_params = {}
+ if 'expand' in params:
+ query_params['expand'] = params['expand']
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='AssistantQueue',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
+ def get_assistant_queues(self, assistant_id: str, **kwargs) -> 'AssistantQueueListing':
+ """
+ Get all the queues associated with an assistant.
+
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_assistant_queues(assistant_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str assistant_id: Assistant ID (required)
+ :param str before: The cursor that points to the start of the set of entities that has been returned.
+ :param str after: The cursor that points to the end of the set of entities that has been returned.
+ :param str page_size: Number of entities to return. Maximum of 200.
+ :param str expand: Which fields, if any, to expand.
+ :return: AssistantQueueListing
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['assistant_id', 'before', 'after', 'page_size', 'expand']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method get_assistant_queues" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'assistant_id' is set
+ if ('assistant_id' not in params) or (params['assistant_id'] is None):
+ raise ValueError("Missing the required parameter `assistant_id` when calling `get_assistant_queues`")
+
+
+ resource_path = '/api/v2/assistants/{assistantId}/queues'.replace('{format}', 'json')
+ path_params = {}
+ if 'assistant_id' in params:
+ path_params['assistantId'] = params['assistant_id']
+
+ query_params = {}
+ if 'before' in params:
+ query_params['before'] = params['before']
+ if 'after' in params:
+ query_params['after'] = params['after']
+ if 'page_size' in params:
+ query_params['pageSize'] = params['page_size']
+ if 'expand' in params:
+ query_params['expand'] = params['expand']
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='AssistantQueueListing',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
+ def get_assistants(self, **kwargs) -> 'AssistantListing':
+ """
+ Get all assistants.
+
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_assistants(callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str before: The cursor that points to the start of the set of entities that has been returned.
+ :param str after: The cursor that points to the end of the set of entities that has been returned.
+ :param str limit: Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
+ :param str page_size: Number of entities to return. Maximum of 200.
+ :param str name: Return the assistant by the given name.
+ :return: AssistantListing
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['before', 'after', 'limit', 'page_size', 'name']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method get_assistants" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+
+
+ resource_path = '/api/v2/assistants'.replace('{format}', 'json')
+ path_params = {}
+
+ query_params = {}
+ if 'before' in params:
+ query_params['before'] = params['before']
+ if 'after' in params:
+ query_params['after'] = params['after']
+ if 'limit' in params:
+ query_params['limit'] = params['limit']
+ if 'page_size' in params:
+ query_params['pageSize'] = params['page_size']
+ if 'name' in params:
+ query_params['name'] = params['name']
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='AssistantListing',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
+ def get_assistants_queues(self, **kwargs) -> 'AssistantQueueListing':
+ """
+ Get all queues assigned to any assistant.
+
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_assistants_queues(callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str before: The cursor that points to the start of the set of entities that has been returned.
+ :param str after: The cursor that points to the end of the set of entities that has been returned.
+ :param str page_size: Number of entities to return. Maximum of 200.
+ :param str queue_ids: Comma-separated identifiers of the queues that need to be retrieved.
+ :param str expand: Which fields, if any, to expand.
+ :return: AssistantQueueListing
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['before', 'after', 'page_size', 'queue_ids', 'expand']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method get_assistants_queues" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+
+
+ resource_path = '/api/v2/assistants/queues'.replace('{format}', 'json')
+ path_params = {}
+
+ query_params = {}
+ if 'before' in params:
+ query_params['before'] = params['before']
+ if 'after' in params:
+ query_params['after'] = params['after']
+ if 'page_size' in params:
+ query_params['pageSize'] = params['page_size']
+ if 'queue_ids' in params:
+ query_params['queueIds'] = params['queue_ids']
+ if 'expand' in params:
+ query_params['expand'] = params['expand']
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='AssistantQueueListing',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
+ def patch_assistant(self, assistant_id: str, body: 'Assistant', **kwargs) -> 'Assistant':
+ """
+ Update an assistant.
+
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.patch_assistant(assistant_id, body, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str assistant_id: Assistant ID (required)
+ :param Assistant body: (required)
+ :return: Assistant
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['assistant_id', 'body']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method patch_assistant" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'assistant_id' is set
+ if ('assistant_id' not in params) or (params['assistant_id'] is None):
+ raise ValueError("Missing the required parameter `assistant_id` when calling `patch_assistant`")
+ # verify the required parameter 'body' is set
+ if ('body' not in params) or (params['body'] is None):
+ raise ValueError("Missing the required parameter `body` when calling `patch_assistant`")
+
+
+ resource_path = '/api/v2/assistants/{assistantId}'.replace('{format}', 'json')
+ path_params = {}
+ if 'assistant_id' in params:
+ path_params['assistantId'] = params['assistant_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'body' in params:
+ body_params = params['body']
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'PATCH',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='Assistant',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
+ def patch_assistant_queues(self, assistant_id: str, body: List['AssistantQueue'], **kwargs) -> 'AssistantQueueListing':
+ """
+ Update Queues for an Assistant.
+
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.patch_assistant_queues(assistant_id, body, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str assistant_id: Assistant ID (required)
+ :param list[AssistantQueue] body: (required)
+ :return: AssistantQueueListing
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['assistant_id', 'body']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method patch_assistant_queues" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'assistant_id' is set
+ if ('assistant_id' not in params) or (params['assistant_id'] is None):
+ raise ValueError("Missing the required parameter `assistant_id` when calling `patch_assistant_queues`")
+ # verify the required parameter 'body' is set
+ if ('body' not in params) or (params['body'] is None):
+ raise ValueError("Missing the required parameter `body` when calling `patch_assistant_queues`")
+
+
+ resource_path = '/api/v2/assistants/{assistantId}/queues'.replace('{format}', 'json')
+ path_params = {}
+ if 'assistant_id' in params:
+ path_params['assistantId'] = params['assistant_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'body' in params:
+ body_params = params['body']
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'PATCH',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='AssistantQueueListing',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
+ def post_assistants(self, body: 'Assistant', **kwargs) -> 'Assistant':
+ """
+ Create an Assistant.
+
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.post_assistants(body, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param Assistant body: (required)
+ :return: Assistant
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['body']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method post_assistants" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'body' is set
+ if ('body' not in params) or (params['body'] is None):
+ raise ValueError("Missing the required parameter `body` when calling `post_assistants`")
+
+
+ resource_path = '/api/v2/assistants'.replace('{format}', 'json')
+ path_params = {}
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'body' in params:
+ body_params = params['body']
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='Assistant',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
+ def put_assistant_queue(self, assistant_id: str, queue_id: str, body: 'AssistantQueue', **kwargs) -> 'AssistantQueue':
+ """
+ Create a queue assistant association.
+
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.put_assistant_queue(assistant_id, queue_id, body, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str assistant_id: Assistant ID (required)
+ :param str queue_id: Queue ID (required)
+ :param AssistantQueue body: (required)
+ :return: AssistantQueue
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['assistant_id', 'queue_id', 'body']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method put_assistant_queue" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'assistant_id' is set
+ if ('assistant_id' not in params) or (params['assistant_id'] is None):
+ raise ValueError("Missing the required parameter `assistant_id` when calling `put_assistant_queue`")
+ # verify the required parameter 'queue_id' is set
+ if ('queue_id' not in params) or (params['queue_id'] is None):
+ raise ValueError("Missing the required parameter `queue_id` when calling `put_assistant_queue`")
+ # verify the required parameter 'body' is set
+ if ('body' not in params) or (params['body'] is None):
+ raise ValueError("Missing the required parameter `body` when calling `put_assistant_queue`")
+
+
+ resource_path = '/api/v2/assistants/{assistantId}/queues/{queueId}'.replace('{format}', 'json')
+ path_params = {}
+ if 'assistant_id' in params:
+ path_params['assistantId'] = params['assistant_id']
+ if 'queue_id' in params:
+ path_params['queueId'] = params['queue_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'body' in params:
+ body_params = params['body']
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'PUT',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='AssistantQueue',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
diff --git a/build/PureCloudPlatformClientV2/apis/agent_copilot_api.py b/build/PureCloudPlatformClientV2/apis/agent_copilot_api.py
new file mode 100644
index 000000000..bdab07cec
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/apis/agent_copilot_api.py
@@ -0,0 +1,220 @@
+# coding: utf-8
+
+"""
+AgentCopilotApi.py
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+"""
+
+from __future__ import absolute_import
+
+import sys
+import os
+import re
+
+from datetime import datetime
+from datetime import date
+
+# python 2 and python 3 compatibility library
+from six import iteritems
+
+from ..configuration import Configuration
+from ..api_client import ApiClient
+from ..utils import deprecated
+
+from typing import List
+from typing import Dict
+from typing import Any
+
+from ..models import Empty
+from ..models import Copilot
+from ..models import ErrorBody
+
+class AgentCopilotApi(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ Ref: https://github.com/swagger-api/swagger-codegen
+ """
+
+ def __init__(self, api_client=None):
+ config = Configuration()
+ if api_client:
+ self.api_client = api_client
+ else:
+ if not config.api_client:
+ config.api_client = ApiClient()
+ self.api_client = config.api_client
+
+ def get_assistant_copilot(self, assistant_id: str, **kwargs) -> 'Copilot':
+ """
+ Get copilot configuration of an assistant.
+
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_assistant_copilot(assistant_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str assistant_id: Assistant ID (required)
+ :return: Copilot
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['assistant_id']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method get_assistant_copilot" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'assistant_id' is set
+ if ('assistant_id' not in params) or (params['assistant_id'] is None):
+ raise ValueError("Missing the required parameter `assistant_id` when calling `get_assistant_copilot`")
+
+
+ resource_path = '/api/v2/assistants/{assistantId}/copilot'.replace('{format}', 'json')
+ path_params = {}
+ if 'assistant_id' in params:
+ path_params['assistantId'] = params['assistant_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='Copilot',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
+ def put_assistant_copilot(self, assistant_id: str, body: 'Copilot', **kwargs) -> 'Copilot':
+ """
+ Update agent copilot configuration
+
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.put_assistant_copilot(assistant_id, body, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str assistant_id: Assistant ID (required)
+ :param Copilot body: (required)
+ :return: Copilot
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['assistant_id', 'body']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method put_assistant_copilot" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'assistant_id' is set
+ if ('assistant_id' not in params) or (params['assistant_id'] is None):
+ raise ValueError("Missing the required parameter `assistant_id` when calling `put_assistant_copilot`")
+ # verify the required parameter 'body' is set
+ if ('body' not in params) or (params['body'] is None):
+ raise ValueError("Missing the required parameter `body` when calling `put_assistant_copilot`")
+
+
+ resource_path = '/api/v2/assistants/{assistantId}/copilot'.replace('{format}', 'json')
+ path_params = {}
+ if 'assistant_id' in params:
+ path_params['assistantId'] = params['assistant_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'body' in params:
+ body_params = params['body']
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'PUT',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='Copilot',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
diff --git a/build/PureCloudPlatformClientV2/apis/analytics_api.py b/build/PureCloudPlatformClientV2/apis/analytics_api.py
index fed8eb50f..5e039657f 100644
--- a/build/PureCloudPlatformClientV2/apis/analytics_api.py
+++ b/build/PureCloudPlatformClientV2/apis/analytics_api.py
@@ -2917,6 +2917,7 @@ def get_analytics_reporting_settings_dashboards_query(self, dashboard_type: str,
for asynchronous request. (optional)
:param str dashboard_type: List dashboard of given type (required)
:param str dashboard_access_filter: Filter dashboard based on the owner of dashboard (required)
+ :param str name: name of the dashboard
:param str sort_by:
:param int page_number:
:param int page_size:
@@ -2925,7 +2926,7 @@ def get_analytics_reporting_settings_dashboards_query(self, dashboard_type: str,
returns the request thread.
"""
- all_params = ['dashboard_type', 'dashboard_access_filter', 'sort_by', 'page_number', 'page_size']
+ all_params = ['dashboard_type', 'dashboard_access_filter', 'name', 'sort_by', 'page_number', 'page_size']
all_params.append('callback')
params = locals()
@@ -2950,6 +2951,8 @@ def get_analytics_reporting_settings_dashboards_query(self, dashboard_type: str,
path_params = {}
query_params = {}
+ if 'name' in params:
+ query_params['name'] = params['name']
if 'dashboard_type' in params:
query_params['dashboardType'] = params['dashboard_type']
if 'dashboard_access_filter' in params:
@@ -4446,7 +4449,6 @@ def post_analytics_agentcopilots_aggregates_query(self, body: 'AgentCopilotAggre
"""
Query for agent copilot aggregates
- post_analytics_agentcopilots_aggregates_query is a preview method and is subject to both breaking and non-breaking changes at any time without notice
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
diff --git a/build/PureCloudPlatformClientV2/apis/external_contacts_api.py b/build/PureCloudPlatformClientV2/apis/external_contacts_api.py
index 91de8ca98..785df4a69 100644
--- a/build/PureCloudPlatformClientV2/apis/external_contacts_api.py
+++ b/build/PureCloudPlatformClientV2/apis/external_contacts_api.py
@@ -56,6 +56,7 @@
from ..models import ContactListing
from ..models import ConversationAssociation
from ..models import CursorContactListing
+from ..models import CursorExternalSourceListing
from ..models import CursorNoteListing
from ..models import CursorOrganizationListing
from ..models import CursorRelationshipListing
@@ -67,6 +68,7 @@
from ..models import ExternalOrganization
from ..models import ExternalOrganizationListing
from ..models import ExternalOrganizationTrustorLink
+from ..models import ExternalSource
from ..models import IdentifierClaimRequest
from ..models import MergeRequest
from ..models import Note
@@ -332,6 +334,85 @@ def delete_externalcontacts_contacts_schema(self, schema_id: str, **kwargs) -> N
callback=params.get('callback'))
return response
+ def delete_externalcontacts_externalsource(self, external_source_id: str, **kwargs) -> object:
+ """
+ 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.
+
+ delete_externalcontacts_externalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.delete_externalcontacts_externalsource(external_source_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str external_source_id: External Source ID (required)
+ :return: object
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['external_source_id']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method delete_externalcontacts_externalsource" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'external_source_id' is set
+ if ('external_source_id' not in params) or (params['external_source_id'] is None):
+ raise ValueError("Missing the required parameter `external_source_id` when calling `delete_externalcontacts_externalsource`")
+
+
+ resource_path = '/api/v2/externalcontacts/externalsources/{externalSourceId}'.replace('{format}', 'json')
+ path_params = {}
+ if 'external_source_id' in params:
+ path_params['externalSourceId'] = params['external_source_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'DELETE',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='object',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
def delete_externalcontacts_organization(self, external_organization_id: str, **kwargs) -> object:
"""
Delete an external organization
@@ -666,7 +747,7 @@ def get_externalcontacts_contact(self, contact_id: str, **kwargs) -> 'ExternalCo
:param callback function: The callback function
for asynchronous request. (optional)
:param str contact_id: ExternalContact ID (required)
- :param list[str] expand: which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
+ :param list[str] expand: which fields, if any, to expand
:return: ExternalContact
If the method is called asynchronously,
returns the request thread.
@@ -1553,6 +1634,170 @@ def get_externalcontacts_contacts_schemas(self, **kwargs) -> 'DataSchemaListing'
callback=params.get('callback'))
return response
+ def get_externalcontacts_externalsource(self, external_source_id: str, **kwargs) -> 'ExternalSource':
+ """
+ Fetch an External Source
+
+ get_externalcontacts_externalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_externalcontacts_externalsource(external_source_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str external_source_id: External Source ID (required)
+ :return: ExternalSource
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['external_source_id']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method get_externalcontacts_externalsource" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'external_source_id' is set
+ if ('external_source_id' not in params) or (params['external_source_id'] is None):
+ raise ValueError("Missing the required parameter `external_source_id` when calling `get_externalcontacts_externalsource`")
+
+
+ resource_path = '/api/v2/externalcontacts/externalsources/{externalSourceId}'.replace('{format}', 'json')
+ path_params = {}
+ if 'external_source_id' in params:
+ path_params['externalSourceId'] = params['external_source_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='ExternalSource',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
+ def get_externalcontacts_externalsources(self, **kwargs) -> 'CursorExternalSourceListing':
+ """
+ Fetch a list of External Sources
+
+ get_externalcontacts_externalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_externalcontacts_externalsources(callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str cursor: Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
+ :param int limit: The number of ExternalSources per page; must be between 10 and 200, default is 100
+ :param str name: Filter by external source name. Filtering is prefix filtering and not an exact match
+ :param bool active: Filter by active status of external source
+ :return: CursorExternalSourceListing
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['cursor', 'limit', 'name', 'active']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method get_externalcontacts_externalsources" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+
+
+ resource_path = '/api/v2/externalcontacts/externalsources'.replace('{format}', 'json')
+ path_params = {}
+
+ query_params = {}
+ if 'cursor' in params:
+ query_params['cursor'] = params['cursor']
+ if 'limit' in params:
+ query_params['limit'] = params['limit']
+ if 'name' in params:
+ query_params['name'] = params['name']
+ if 'active' in params:
+ query_params['active'] = params['active']
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='CursorExternalSourceListing',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
def get_externalcontacts_organization(self, external_organization_id: str, **kwargs) -> 'ExternalOrganization':
"""
Fetch an external organization
@@ -4604,6 +4849,85 @@ def post_externalcontacts_contacts_schemas(self, body: 'DataSchema', **kwargs) -
callback=params.get('callback'))
return response
+ def post_externalcontacts_externalsources(self, body: 'ExternalSource', **kwargs) -> 'ExternalSource':
+ """
+ Create an External Source
+
+ post_externalcontacts_externalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.post_externalcontacts_externalsources(body, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param ExternalSource body: External Source (required)
+ :return: ExternalSource
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['body']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method post_externalcontacts_externalsources" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'body' is set
+ if ('body' not in params) or (params['body'] is None):
+ raise ValueError("Missing the required parameter `body` when calling `post_externalcontacts_externalsources`")
+
+
+ resource_path = '/api/v2/externalcontacts/externalsources'.replace('{format}', 'json')
+ path_params = {}
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'body' in params:
+ body_params = params['body']
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='ExternalSource',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
def post_externalcontacts_identifierlookup(self, identifier: 'ContactIdentifier', **kwargs) -> 'ExternalContact':
"""
Fetch a contact using an identifier type and value.
@@ -5423,6 +5747,91 @@ def put_externalcontacts_conversation(self, conversation_id: str, body: 'Convers
callback=params.get('callback'))
return response
+ def put_externalcontacts_externalsource(self, external_source_id: str, body: 'ExternalSource', **kwargs) -> 'ExternalSource':
+ """
+ Update an External Source
+
+ put_externalcontacts_externalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.put_externalcontacts_externalsource(external_source_id, body, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str external_source_id: External Source ID (required)
+ :param ExternalSource body: External Source (required)
+ :return: ExternalSource
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['external_source_id', 'body']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method put_externalcontacts_externalsource" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'external_source_id' is set
+ if ('external_source_id' not in params) or (params['external_source_id'] is None):
+ raise ValueError("Missing the required parameter `external_source_id` when calling `put_externalcontacts_externalsource`")
+ # verify the required parameter 'body' is set
+ if ('body' not in params) or (params['body'] is None):
+ raise ValueError("Missing the required parameter `body` when calling `put_externalcontacts_externalsource`")
+
+
+ resource_path = '/api/v2/externalcontacts/externalsources/{externalSourceId}'.replace('{format}', 'json')
+ path_params = {}
+ if 'external_source_id' in params:
+ path_params['externalSourceId'] = params['external_source_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'body' in params:
+ body_params = params['body']
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'PUT',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='ExternalSource',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
def put_externalcontacts_organization(self, external_organization_id: str, body: 'ExternalOrganization', **kwargs) -> 'ExternalOrganization':
"""
Update an external organization
diff --git a/build/PureCloudPlatformClientV2/apis/journey_api.py b/build/PureCloudPlatformClientV2/apis/journey_api.py
index d2fa9ca8a..7c370831e 100644
--- a/build/PureCloudPlatformClientV2/apis/journey_api.py
+++ b/build/PureCloudPlatformClientV2/apis/journey_api.py
@@ -507,7 +507,6 @@ def delete_journey_view(self, view_id: str, **kwargs) -> None:
"""
Delete a Journey View by ID
deletes all versions
- delete_journey_view is a preview method and is subject to both breaking and non-breaking changes at any time without notice
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
@@ -2480,7 +2479,6 @@ def get_journey_view(self, view_id: str, **kwargs) -> 'JourneyView':
"""
Get a Journey View by ID
returns the latest version
- get_journey_view is a preview method and is subject to both breaking and non-breaking changes at any time without notice
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
@@ -2559,7 +2557,6 @@ def get_journey_view_version(self, view_id: str, version_id: str, **kwargs) -> '
"""
Get a Journey View by ID and version
- get_journey_view_version is a preview method and is subject to both breaking and non-breaking changes at any time without notice
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
@@ -2644,7 +2641,6 @@ def get_journey_view_version_job(self, view_id: str, journey_version_id: str, jo
"""
Get the job for a journey view version.
used for long descriptions
- get_journey_view_version_job is a preview method and is subject to both breaking and non-breaking changes at any time without notice
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
@@ -2735,7 +2731,6 @@ def get_journey_view_version_job_results(self, view_id: str, journey_view_versio
"""
Get the result of a job for a journey view version.
used for long descriptions
- get_journey_view_version_job_results is a preview method and is subject to both breaking and non-breaking changes at any time without notice
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
@@ -2826,7 +2821,6 @@ def get_journey_view_version_jobs_latest(self, view_id: str, journey_version_id:
"""
Get the latest job of a journey view version.
used for long descriptions
- get_journey_view_version_jobs_latest is a preview method and is subject to both breaking and non-breaking changes at any time without notice
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
@@ -2911,7 +2905,6 @@ def get_journey_views(self, **kwargs) -> 'JourneyViewListing':
"""
Get a list of Journey Views
- get_journey_views is a preview method and is subject to both breaking and non-breaking changes at any time without notice
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
@@ -2927,12 +2920,13 @@ def get_journey_views(self, **kwargs) -> 'JourneyViewListing':
:param int page_size: Page size
:param str name_or_created_by: Journey View Name or Created By
:param str expand: Parameter to request additional data to return in Journey payload
+ :param str id: Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items.
:return: JourneyViewListing
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['page_number', 'page_size', 'name_or_created_by', 'expand']
+ all_params = ['page_number', 'page_size', 'name_or_created_by', 'expand', 'id']
all_params.append('callback')
params = locals()
@@ -2959,6 +2953,8 @@ def get_journey_views(self, **kwargs) -> 'JourneyViewListing':
query_params['nameOrCreatedBy'] = params['name_or_created_by']
if 'expand' in params:
query_params['expand'] = params['expand']
+ if 'id' in params:
+ query_params['id'] = params['id']
header_params = {}
@@ -3148,7 +3144,6 @@ def get_journey_views_jobs(self, **kwargs) -> 'JourneyViewJobListing':
"""
Get the jobs for an organization.
- get_journey_views_jobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
@@ -4645,7 +4640,6 @@ def post_journey_view_version_jobs(self, view_id: str, journey_version_id: str,
"""
Submit a job request for a journey view version.
used for long descriptions
- post_journey_view_version_jobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
@@ -4730,7 +4724,6 @@ def post_journey_view_versions(self, view_id: str, body: 'JourneyView', **kwargs
"""
Update a Journey View by ID
creates a new version
- post_journey_view_versions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
@@ -4815,7 +4808,6 @@ def post_journey_views(self, body: 'JourneyView', **kwargs) -> 'JourneyView':
"""
Create a new Journey View
- post_journey_views is a preview method and is subject to both breaking and non-breaking changes at any time without notice
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
diff --git a/build/PureCloudPlatformClientV2/apis/knowledge_api.py b/build/PureCloudPlatformClientV2/apis/knowledge_api.py
index d9d24787f..21f9fbf32 100644
--- a/build/PureCloudPlatformClientV2/apis/knowledge_api.py
+++ b/build/PureCloudPlatformClientV2/apis/knowledge_api.py
@@ -53,6 +53,7 @@
from ..models import GetUploadSourceUrlJobStatusResponse
from ..models import GuestCategoryResponseListing
from ..models import ImportStatusRequest
+from ..models import KnowledgeAnswerDocumentsResponse
from ..models import KnowledgeBase
from ..models import KnowledgeBaseCreateRequest
from ..models import KnowledgeBaseListing
@@ -69,6 +70,7 @@
from ..models import KnowledgeDocumentFeedback
from ..models import KnowledgeDocumentFeedbackResponse
from ..models import KnowledgeDocumentFeedbackResponseListing
+from ..models import KnowledgeDocumentFeedbackUpdateRequest
from ..models import KnowledgeDocumentGuestSearch
from ..models import KnowledgeDocumentGuestSearchRequest
from ..models import KnowledgeDocumentPresentation
@@ -87,9 +89,11 @@
from ..models import KnowledgeDocumentVersionVariation
from ..models import KnowledgeDocumentVersionVariationListing
from ..models import KnowledgeDocumentView
+from ..models import KnowledgeDocumentsAnswerFilter
from ..models import KnowledgeExportJobRequest
from ..models import KnowledgeExportJobResponse
from ..models import KnowledgeExtendedCategory
+from ..models import KnowledgeGuestAnswerDocumentsResponse
from ..models import KnowledgeGuestDocumentCopy
from ..models import KnowledgeGuestDocumentFeedback
from ..models import KnowledgeGuestDocumentPresentation
@@ -4732,6 +4736,99 @@ def patch_knowledge_knowledgebase_document(self, knowledge_base_id: str, documen
callback=params.get('callback'))
return response
+ def patch_knowledge_knowledgebase_document_feedback_feedback_id(self, knowledge_base_id: str, document_id: str, feedback_id: str, **kwargs) -> 'KnowledgeDocumentFeedbackResponse':
+ """
+ Update feedback on a document
+
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.patch_knowledge_knowledgebase_document_feedback_feedback_id(knowledge_base_id, document_id, feedback_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str knowledge_base_id: Knowledge base ID. (required)
+ :param str document_id: Document ID. (required)
+ :param str feedback_id: Feedback ID. (required)
+ :param KnowledgeDocumentFeedbackUpdateRequest body:
+ :return: KnowledgeDocumentFeedbackResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['knowledge_base_id', 'document_id', 'feedback_id', 'body']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method patch_knowledge_knowledgebase_document_feedback_feedback_id" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'knowledge_base_id' is set
+ if ('knowledge_base_id' not in params) or (params['knowledge_base_id'] is None):
+ raise ValueError("Missing the required parameter `knowledge_base_id` when calling `patch_knowledge_knowledgebase_document_feedback_feedback_id`")
+ # verify the required parameter 'document_id' is set
+ if ('document_id' not in params) or (params['document_id'] is None):
+ raise ValueError("Missing the required parameter `document_id` when calling `patch_knowledge_knowledgebase_document_feedback_feedback_id`")
+ # verify the required parameter 'feedback_id' is set
+ if ('feedback_id' not in params) or (params['feedback_id'] is None):
+ raise ValueError("Missing the required parameter `feedback_id` when calling `patch_knowledge_knowledgebase_document_feedback_feedback_id`")
+
+
+ resource_path = '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}'.replace('{format}', 'json')
+ path_params = {}
+ if 'knowledge_base_id' in params:
+ path_params['knowledgeBaseId'] = params['knowledge_base_id']
+ if 'document_id' in params:
+ path_params['documentId'] = params['document_id']
+ if 'feedback_id' in params:
+ path_params['feedbackId'] = params['feedback_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'body' in params:
+ body_params = params['body']
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'PATCH',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='KnowledgeDocumentFeedbackResponse',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
def patch_knowledge_knowledgebase_document_variation(self, document_variation_id: str, document_id: str, knowledge_base_id: str, body: 'DocumentVariation', **kwargs) -> 'DocumentVariation':
"""
Update a variation for a document.
@@ -6003,6 +6100,90 @@ def post_knowledge_guest_session_document_views(self, session_id: str, document_
callback=params.get('callback'))
return response
+ def post_knowledge_guest_session_documents_answers(self, session_id: str, body: 'KnowledgeDocumentsAnswerFilter', **kwargs) -> 'KnowledgeGuestAnswerDocumentsResponse':
+ """
+ Answer documents.
+
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.post_knowledge_guest_session_documents_answers(session_id, body, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str session_id: Knowledge guest session ID. (required)
+ :param KnowledgeDocumentsAnswerFilter body: (required)
+ :return: KnowledgeGuestAnswerDocumentsResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['session_id', 'body']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method post_knowledge_guest_session_documents_answers" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'session_id' is set
+ if ('session_id' not in params) or (params['session_id'] is None):
+ raise ValueError("Missing the required parameter `session_id` when calling `post_knowledge_guest_session_documents_answers`")
+ # verify the required parameter 'body' is set
+ if ('body' not in params) or (params['body'] is None):
+ raise ValueError("Missing the required parameter `body` when calling `post_knowledge_guest_session_documents_answers`")
+
+
+ resource_path = '/api/v2/knowledge/guest/sessions/{sessionId}/documents/answers'.replace('{format}', 'json')
+ path_params = {}
+ if 'session_id' in params:
+ path_params['sessionId'] = params['session_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'body' in params:
+ body_params = params['body']
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = []
+
+ response = self.api_client.call_api(resource_path, 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='KnowledgeGuestAnswerDocumentsResponse',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
def post_knowledge_guest_session_documents_presentations(self, session_id: str, **kwargs) -> None:
"""
Indicate that documents were presented to the user.
@@ -6936,6 +7117,90 @@ def post_knowledge_knowledgebase_documents(self, knowledge_base_id: str, body: '
callback=params.get('callback'))
return response
+ def post_knowledge_knowledgebase_documents_answers(self, knowledge_base_id: str, body: 'KnowledgeDocumentsAnswerFilter', **kwargs) -> 'KnowledgeAnswerDocumentsResponse':
+ """
+ Answer documents.
+
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.post_knowledge_knowledgebase_documents_answers(knowledge_base_id, body, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str knowledge_base_id: Knowledge base ID (required)
+ :param KnowledgeDocumentsAnswerFilter body: (required)
+ :return: KnowledgeAnswerDocumentsResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['knowledge_base_id', 'body']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method post_knowledge_knowledgebase_documents_answers" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'knowledge_base_id' is set
+ if ('knowledge_base_id' not in params) or (params['knowledge_base_id'] is None):
+ raise ValueError("Missing the required parameter `knowledge_base_id` when calling `post_knowledge_knowledgebase_documents_answers`")
+ # verify the required parameter 'body' is set
+ if ('body' not in params) or (params['body'] is None):
+ raise ValueError("Missing the required parameter `body` when calling `post_knowledge_knowledgebase_documents_answers`")
+
+
+ resource_path = '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/answers'.replace('{format}', 'json')
+ path_params = {}
+ if 'knowledge_base_id' in params:
+ path_params['knowledgeBaseId'] = params['knowledge_base_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'body' in params:
+ body_params = params['body']
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='KnowledgeAnswerDocumentsResponse',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
def post_knowledge_knowledgebase_documents_bulk_remove(self, knowledge_base_id: str, body: 'KnowledgeDocumentBulkRemoveRequest', **kwargs) -> 'BulkResponse':
"""
Bulk remove documents.
diff --git a/build/PureCloudPlatformClientV2/apis/routing_api.py b/build/PureCloudPlatformClientV2/apis/routing_api.py
index c732ea5a8..bdbb642bf 100644
--- a/build/PureCloudPlatformClientV2/apis/routing_api.py
+++ b/build/PureCloudPlatformClientV2/apis/routing_api.py
@@ -42,6 +42,7 @@
from ..models import AgentMaxUtilizationResponse
from ..models import AssessmentJobListing
from ..models import AssessmentListing
+from ..models import AssistantQueue
from ..models import AvailableMediaTypeEntityListing
from ..models import BenefitAssessment
from ..models import BenefitAssessmentJob
@@ -4033,6 +4034,87 @@ def get_routing_queue(self, queue_id: str, **kwargs) -> 'Queue':
callback=params.get('callback'))
return response
+ def get_routing_queue_assistant(self, queue_id: str, **kwargs) -> 'AssistantQueue':
+ """
+ Get an assistant associated with a queue.
+
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_routing_queue_assistant(queue_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str queue_id: Queue ID (required)
+ :param str expand: Which fields, if any, to expand.
+ :return: AssistantQueue
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['queue_id', 'expand']
+ all_params.append('callback')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method get_routing_queue_assistant" % key
+ )
+ params[key] = val
+ del params['kwargs']
+
+ # verify the required parameter 'queue_id' is set
+ if ('queue_id' not in params) or (params['queue_id'] is None):
+ raise ValueError("Missing the required parameter `queue_id` when calling `get_routing_queue_assistant`")
+
+
+ resource_path = '/api/v2/routing/queues/{queueId}/assistant'.replace('{format}', 'json')
+ path_params = {}
+ if 'queue_id' in params:
+ path_params['queueId'] = params['queue_id']
+
+ query_params = {}
+ if 'expand' in params:
+ query_params['expand'] = params['expand']
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+ if not header_params['Accept']:
+ del header_params['Accept']
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['PureCloud OAuth']
+
+ response = self.api_client.call_api(resource_path, 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='AssistantQueue',
+ auth_settings=auth_settings,
+ callback=params.get('callback'))
+ return response
+
def get_routing_queue_comparisonperiod(self, queue_id: str, comparison_period_id: str, **kwargs) -> 'ComparisonPeriod':
"""
Get a Comparison Period.
diff --git a/build/PureCloudPlatformClientV2/apis/settings_api.py b/build/PureCloudPlatformClientV2/apis/settings_api.py
index ca7d01dcc..02c98fdff 100644
--- a/build/PureCloudPlatformClientV2/apis/settings_api.py
+++ b/build/PureCloudPlatformClientV2/apis/settings_api.py
@@ -214,7 +214,6 @@ def get_settings_executiondata(self, **kwargs) -> 'ExecutionDataGlobalSettingsRe
"""
Get the execution history enabled setting.
Get the execution history enabled setting.
- get_settings_executiondata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
@@ -440,7 +439,6 @@ def patch_settings_executiondata(self, body: 'ExecutionDataSettingsRequest', **k
"""
Edit the execution history on off setting.
Edit the execution history on off setting.
- patch_settings_executiondata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
diff --git a/build/PureCloudPlatformClientV2/configuration.py b/build/PureCloudPlatformClientV2/configuration.py
index cac077e5d..ccf30c463 100644
--- a/build/PureCloudPlatformClientV2/configuration.py
+++ b/build/PureCloudPlatformClientV2/configuration.py
@@ -202,7 +202,7 @@ def to_debug_report(self):
"OS: {env}\n"\
"Python Version: {pyversion}\n"\
"Version of the API: v2\n"\
- "SDK Package Version: 210.0.0".\
+ "SDK Package Version: 211.0.0".\
format(env=sys.platform, pyversion=sys.version)
def _update_config_from_file(self):
diff --git a/build/PureCloudPlatformClientV2/models/__init__.py b/build/PureCloudPlatformClientV2/models/__init__.py
index 04327489b..bd033bf6e 100644
--- a/build/PureCloudPlatformClientV2/models/__init__.py
+++ b/build/PureCloudPlatformClientV2/models/__init__.py
@@ -220,6 +220,7 @@
from .analytics_user_details_query_response import AnalyticsUserDetailsQueryResponse
from .analytics_user_presence_record import AnalyticsUserPresenceRecord
from .annotation import Annotation
+from .answer_generation_config import AnswerGenerationConfig
from .answer_generation_document import AnswerGenerationDocument
from .answer_option import AnswerOption
from .api_usage_client_query import ApiUsageClientQuery
@@ -286,6 +287,10 @@
from .assignment_error import AssignmentError
from .assignment_validation import AssignmentValidation
from .assistance_condition import AssistanceCondition
+from .assistant import Assistant
+from .assistant_listing import AssistantListing
+from .assistant_queue import AssistantQueue
+from .assistant_queue_listing import AssistantQueueListing
from .associated_value_field import AssociatedValueField
from .async_conversation_query import AsyncConversationQuery
from .async_forecast_operation_result import AsyncForecastOperationResult
@@ -398,6 +403,8 @@
from .bot_version_summary import BotVersionSummary
from .browser import Browser
from .bu_abandon_rate import BuAbandonRate
+from .bu_activity_settings_request import BuActivitySettingsRequest
+from .bu_activity_settings_response import BuActivitySettingsResponse
from .bu_agent_schedule_activity import BuAgentScheduleActivity
from .bu_agent_schedule_history_change import BuAgentScheduleHistoryChange
from .bu_agent_schedule_history_change_metadata import BuAgentScheduleHistoryChangeMetadata
@@ -444,6 +451,8 @@
from .bu_intraday_schedule_data import BuIntradayScheduleData
from .bu_list_alternative_shift_trades_response import BuListAlternativeShiftTradesResponse
from .bu_management_unit_schedule_summary import BuManagementUnitScheduleSummary
+from .bu_notification_settings_request import BuNotificationSettingsRequest
+from .bu_notification_settings_response import BuNotificationSettingsResponse
from .bu_planning_group_headcount_forecast import BuPlanningGroupHeadcountForecast
from .bu_query_adherence_explanations_request import BuQueryAdherenceExplanationsRequest
from .bu_query_adherence_explanations_response import BuQueryAdherenceExplanationsResponse
@@ -454,6 +463,9 @@
from .bu_schedule_list_item import BuScheduleListItem
from .bu_schedule_listing import BuScheduleListing
from .bu_schedule_metadata import BuScheduleMetadata
+from .bu_schedule_notifications_category_settings import BuScheduleNotificationsCategorySettings
+from .bu_schedule_notifications_settings_request import BuScheduleNotificationsSettingsRequest
+from .bu_schedule_notifications_settings_response import BuScheduleNotificationsSettingsResponse
from .bu_schedule_reference import BuScheduleReference
from .bu_schedule_reference_for_mu_route import BuScheduleReferenceForMuRoute
from .bu_schedule_run import BuScheduleRun
@@ -590,6 +602,7 @@
from .campaign_rule_action import CampaignRuleAction
from .campaign_rule_action_entities import CampaignRuleActionEntities
from .campaign_rule_condition import CampaignRuleCondition
+from .campaign_rule_condition_group import CampaignRuleConditionGroup
from .campaign_rule_entities import CampaignRuleEntities
from .campaign_rule_entity_listing import CampaignRuleEntityListing
from .campaign_rule_parameters import CampaignRuleParameters
@@ -1004,6 +1017,7 @@
from .conversation_notification_template_parameter import ConversationNotificationTemplateParameter
from .conversation_participant_search_criteria import ConversationParticipantSearchCriteria
from .conversation_participant_search_request import ConversationParticipantSearchRequest
+from .conversation_profile import ConversationProfile
from .conversation_properties import ConversationProperties
from .conversation_public_metadata import ConversationPublicMetadata
from .conversation_query import ConversationQuery
@@ -1061,6 +1075,13 @@
from .conversation_video_event_topic_video_conversation import ConversationVideoEventTopicVideoConversation
from .conversation_video_event_topic_video_media_participant import ConversationVideoEventTopicVideoMediaParticipant
from .conversation_video_event_topic_wrapup import ConversationVideoEventTopicWrapup
+from .copilot import Copilot
+from .copilot_action import CopilotAction
+from .copilot_condition import CopilotCondition
+from .copilot_fallback_action import CopilotFallbackAction
+from .copilot_nlu_domain import CopilotNluDomain
+from .copilot_nlu_domain_version import CopilotNluDomainVersion
+from .copilot_rule import CopilotRule
from .copy_attachments_request import CopyAttachmentsRequest
from .copy_bu_forecast_request import CopyBuForecastRequest
from .copy_voicemail_message import CopyVoicemailMessage
@@ -1151,6 +1172,7 @@
from .current_user_schedule_request_body import CurrentUserScheduleRequestBody
from .current_user_time_off_integration_status_request import CurrentUserTimeOffIntegrationStatusRequest
from .cursor_contact_listing import CursorContactListing
+from .cursor_external_source_listing import CursorExternalSourceListing
from .cursor_note_listing import CursorNoteListing
from .cursor_organization_listing import CursorOrganizationListing
from .cursor_relationship_listing import CursorRelationshipListing
@@ -1734,6 +1756,7 @@
from .facet_term import FacetTerm
from .failed_object import FailedObject
from .failed_recording_entity_listing import FailedRecordingEntityListing
+from .fallback import Fallback
from .faq import Faq
from .fax_config import FaxConfig
from .fax_document import FaxDocument
@@ -1903,6 +1926,7 @@
from .get_rules_query import GetRulesQuery
from .get_templates_response import GetTemplatesResponse
from .get_upload_source_url_job_status_response import GetUploadSourceUrlJobStatusResponse
+from .google_dialogflow_config import GoogleDialogflowConfig
from .google_dialogflow_custom_settings import GoogleDialogflowCustomSettings
from .grammar import Grammar
from .grammar_file_upload_request import GrammarFileUploadRequest
@@ -2218,6 +2242,9 @@
from .knowledge_aggregate_query_response import KnowledgeAggregateQueryResponse
from .knowledge_aggregation_query import KnowledgeAggregationQuery
from .knowledge_aggregation_view import KnowledgeAggregationView
+from .knowledge_answer_config import KnowledgeAnswerConfig
+from .knowledge_answer_document_response import KnowledgeAnswerDocumentResponse
+from .knowledge_answer_documents_response import KnowledgeAnswerDocumentsResponse
from .knowledge_answer_generation_response import KnowledgeAnswerGenerationResponse
from .knowledge_async_aggregate_query_response import KnowledgeAsyncAggregateQueryResponse
from .knowledge_async_aggregation_query import KnowledgeAsyncAggregationQuery
@@ -2226,6 +2253,7 @@
from .knowledge_base_listing import KnowledgeBaseListing
from .knowledge_base_reference import KnowledgeBaseReference
from .knowledge_base_update_request import KnowledgeBaseUpdateRequest
+from .knowledge_base_with_dialect_reference import KnowledgeBaseWithDialectReference
from .knowledge_category import KnowledgeCategory
from .knowledge_category_request import KnowledgeCategoryRequest
from .knowledge_context_reference import KnowledgeContextReference
@@ -2245,6 +2273,7 @@
from .knowledge_document_feedback import KnowledgeDocumentFeedback
from .knowledge_document_feedback_response import KnowledgeDocumentFeedbackResponse
from .knowledge_document_feedback_response_listing import KnowledgeDocumentFeedbackResponseListing
+from .knowledge_document_feedback_update_request import KnowledgeDocumentFeedbackUpdateRequest
from .knowledge_document_guest_search import KnowledgeDocumentGuestSearch
from .knowledge_document_guest_search_request import KnowledgeDocumentGuestSearchRequest
from .knowledge_document_guest_search_result import KnowledgeDocumentGuestSearchResult
@@ -2270,12 +2299,15 @@
from .knowledge_document_version_variation_listing import KnowledgeDocumentVersionVariationListing
from .knowledge_document_version_variation_reference import KnowledgeDocumentVersionVariationReference
from .knowledge_document_view import KnowledgeDocumentView
+from .knowledge_documents_answer_filter import KnowledgeDocumentsAnswerFilter
from .knowledge_export_job_documents_filter import KnowledgeExportJobDocumentsFilter
from .knowledge_export_job_filter import KnowledgeExportJobFilter
from .knowledge_export_job_request import KnowledgeExportJobRequest
from .knowledge_export_job_response import KnowledgeExportJobResponse
from .knowledge_extended_category import KnowledgeExtendedCategory
from .knowledge_group_statistics import KnowledgeGroupStatistics
+from .knowledge_guest_answer_document_response import KnowledgeGuestAnswerDocumentResponse
+from .knowledge_guest_answer_documents_response import KnowledgeGuestAnswerDocumentsResponse
from .knowledge_guest_document_copy import KnowledgeGuestDocumentCopy
from .knowledge_guest_document_feedback import KnowledgeGuestDocumentFeedback
from .knowledge_guest_document_presentation import KnowledgeGuestDocumentPresentation
@@ -2313,6 +2345,7 @@
from .knowledge_search_document_v1 import KnowledgeSearchDocumentV1
from .knowledge_search_request import KnowledgeSearchRequest
from .knowledge_search_response import KnowledgeSearchResponse
+from .knowledge_suggestion_config import KnowledgeSuggestionConfig
from .knowledge_training import KnowledgeTraining
from .kpi_result import KpiResult
from .label import Label
@@ -2632,6 +2665,7 @@
from .namespace_docs import NamespaceDocs
from .network_connectivity import NetworkConnectivity
from .next_occurrence_details import NextOccurrenceDetails
+from .nlu_config import NluConfig
from .nlu_confusion_matrix_column import NluConfusionMatrixColumn
from .nlu_confusion_matrix_row import NluConfusionMatrixRow
from .nlu_detection_context import NluDetectionContext
@@ -3417,6 +3451,8 @@
from .routing_status_detail_query_filter import RoutingStatusDetailQueryFilter
from .routing_status_detail_query_predicate import RoutingStatusDetailQueryPredicate
from .routing_transfer_event import RoutingTransferEvent
+from .rule_config import RuleConfig
+from .rule_engine_config import RuleEngineConfig
from .rule_set import RuleSet
from .rule_set_diagnostic import RuleSetDiagnostic
from .rule_set_entity_listing import RuleSetEntityListing
@@ -3669,6 +3705,7 @@
from .suggestion_knowledge_search import SuggestionKnowledgeSearch
from .suggestion_listing import SuggestionListing
from .suggestion_script import SuggestionScript
+from .summary_generation_config import SummaryGenerationConfig
from .support_center_category import SupportCenterCategory
from .support_center_compact_category_module_template import SupportCenterCompactCategoryModuleTemplate
from .support_center_custom_message import SupportCenterCustomMessage
@@ -3855,6 +3892,7 @@
from .transcript_topics import TranscriptTopics
from .transcript_url import TranscriptUrl
from .transcript_urls import TranscriptUrls
+from .transcription_config import TranscriptionConfig
from .transcription_engines_request import TranscriptionEnginesRequest
from .transcription_settings import TranscriptionSettings
from .transcription_topic_transcript_alternative import TranscriptionTopicTranscriptAlternative
@@ -4517,6 +4555,7 @@
from .workitem_create import WorkitemCreate
from .workitem_delta import WorkitemDelta
from .workitem_filter import WorkitemFilter
+from .workitem_flow_reference import WorkitemFlowReference
from .workitem_manual_assign import WorkitemManualAssign
from .workitem_paged_entity_listing import WorkitemPagedEntityListing
from .workitem_post_query_entity_listing import WorkitemPostQueryEntityListing
@@ -4529,6 +4568,7 @@
from .workitem_query_sort import WorkitemQuerySort
from .workitem_queue_reference import WorkitemQueueReference
from .workitem_reference import WorkitemReference
+from .workitem_rule_settings import WorkitemRuleSettings
from .workitem_schema import WorkitemSchema
from .workitem_scored_agent import WorkitemScoredAgent
from .workitem_scored_agent_request import WorkitemScoredAgentRequest
@@ -4596,6 +4636,7 @@
from .wrapup import Wrapup
from .wrapup_code import WrapupCode
from .wrapup_code_entity_listing import WrapupCodeEntityListing
+from .wrapup_code_prediction_config import WrapupCodePredictionConfig
from .wrapup_code_request import WrapupCodeRequest
from .wrapup_detail_event_topic_wrapup_event import WrapupDetailEventTopicWrapupEvent
from .wrapup_id_reference import WrapupIdReference
diff --git a/build/PureCloudPlatformClientV2/models/accelerator_list.py b/build/PureCloudPlatformClientV2/models/accelerator_list.py
index 4e7b8fa16..c5eef468e 100644
--- a/build/PureCloudPlatformClientV2/models/accelerator_list.py
+++ b/build/PureCloudPlatformClientV2/models/accelerator_list.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this AcceleratorList.
+ Gets the first_uri of this AcceleratorList.
- :return: The last_uri of this AcceleratorList.
+ :return: The first_uri of this AcceleratorList.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this AcceleratorList.
+ Sets the first_uri of this AcceleratorList.
- :param last_uri: The last_uri of this AcceleratorList.
+ :param first_uri: The first_uri of this AcceleratorList.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this AcceleratorList.
+ Gets the last_uri of this AcceleratorList.
- :return: The first_uri of this AcceleratorList.
+ :return: The last_uri of this AcceleratorList.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this AcceleratorList.
+ Sets the last_uri of this AcceleratorList.
- :param first_uri: The first_uri of this AcceleratorList.
+ :param last_uri: The last_uri of this AcceleratorList.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/acd_end_detail_event_topic_acd_end_event.py b/build/PureCloudPlatformClientV2/models/acd_end_detail_event_topic_acd_end_event.py
index f7160ca0a..3faf25059 100644
--- a/build/PureCloudPlatformClientV2/models/acd_end_detail_event_topic_acd_end_event.py
+++ b/build/PureCloudPlatformClientV2/models/acd_end_detail_event_topic_acd_end_event.py
@@ -77,7 +77,9 @@ def __init__(self) -> None:
'routing_priority': 'int',
'connected_duration_ms': 'int',
'conversation_external_contact_ids': 'list[str]',
- 'conversation_external_organization_ids': 'list[str]'
+ 'conversation_external_organization_ids': 'list[str]',
+ 'utilization_label': 'str',
+ 'flow_type': 'str'
}
self.attribute_map = {
@@ -110,7 +112,9 @@ def __init__(self) -> None:
'routing_priority': 'routingPriority',
'connected_duration_ms': 'connectedDurationMs',
'conversation_external_contact_ids': 'conversationExternalContactIds',
- 'conversation_external_organization_ids': 'conversationExternalOrganizationIds'
+ 'conversation_external_organization_ids': 'conversationExternalOrganizationIds',
+ 'utilization_label': 'utilizationLabel',
+ 'flow_type': 'flowType'
}
self._event_time = None
@@ -143,6 +147,8 @@ def __init__(self) -> None:
self._connected_duration_ms = None
self._conversation_external_contact_ids = None
self._conversation_external_organization_ids = None
+ self._utilization_label = None
+ self._flow_type = None
@property
def event_time(self) -> int:
@@ -565,7 +571,7 @@ def message_type(self, message_type: str) -> None:
"""
if isinstance(message_type, int):
message_type = str(message_type)
- allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM"]
+ allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM", "APPLE"]
if message_type.lower() not in map(str.lower, allowed_values):
# print("Invalid value for message_type -> " + message_type)
self._message_type = "outdated_sdk_version"
@@ -894,6 +900,54 @@ def conversation_external_organization_ids(self, conversation_external_organizat
self._conversation_external_organization_ids = conversation_external_organization_ids
+ @property
+ def utilization_label(self) -> str:
+ """
+ Gets the utilization_label of this AcdEndDetailEventTopicAcdEndEvent.
+
+
+ :return: The utilization_label of this AcdEndDetailEventTopicAcdEndEvent.
+ :rtype: str
+ """
+ return self._utilization_label
+
+ @utilization_label.setter
+ def utilization_label(self, utilization_label: str) -> None:
+ """
+ Sets the utilization_label of this AcdEndDetailEventTopicAcdEndEvent.
+
+
+ :param utilization_label: The utilization_label of this AcdEndDetailEventTopicAcdEndEvent.
+ :type: str
+ """
+
+
+ self._utilization_label = utilization_label
+
+ @property
+ def flow_type(self) -> str:
+ """
+ Gets the flow_type of this AcdEndDetailEventTopicAcdEndEvent.
+
+
+ :return: The flow_type of this AcdEndDetailEventTopicAcdEndEvent.
+ :rtype: str
+ """
+ return self._flow_type
+
+ @flow_type.setter
+ def flow_type(self, flow_type: str) -> None:
+ """
+ Sets the flow_type of this AcdEndDetailEventTopicAcdEndEvent.
+
+
+ :param flow_type: The flow_type of this AcdEndDetailEventTopicAcdEndEvent.
+ :type: str
+ """
+
+
+ self._flow_type = flow_type
+
def to_dict(self):
"""
Returns the model properties as a dict
diff --git a/build/PureCloudPlatformClientV2/models/acd_start_detail_event_topic_acd_start_event.py b/build/PureCloudPlatformClientV2/models/acd_start_detail_event_topic_acd_start_event.py
index bd2bb4a50..becc1db44 100644
--- a/build/PureCloudPlatformClientV2/models/acd_start_detail_event_topic_acd_start_event.py
+++ b/build/PureCloudPlatformClientV2/models/acd_start_detail_event_topic_acd_start_event.py
@@ -67,7 +67,10 @@ def __init__(self) -> None:
'queue_id': 'str',
'division_id': 'str',
'conversation_external_contact_ids': 'list[str]',
- 'conversation_external_organization_ids': 'list[str]'
+ 'conversation_external_organization_ids': 'list[str]',
+ 'utilization_label': 'str',
+ 'routing_priority': 'int',
+ 'requested_routing_skill_ids': 'list[str]'
}
self.attribute_map = {
@@ -90,7 +93,10 @@ def __init__(self) -> None:
'queue_id': 'queueId',
'division_id': 'divisionId',
'conversation_external_contact_ids': 'conversationExternalContactIds',
- 'conversation_external_organization_ids': 'conversationExternalOrganizationIds'
+ 'conversation_external_organization_ids': 'conversationExternalOrganizationIds',
+ 'utilization_label': 'utilizationLabel',
+ 'routing_priority': 'routingPriority',
+ 'requested_routing_skill_ids': 'requestedRoutingSkillIds'
}
self._event_time = None
@@ -113,6 +119,9 @@ def __init__(self) -> None:
self._division_id = None
self._conversation_external_contact_ids = None
self._conversation_external_organization_ids = None
+ self._utilization_label = None
+ self._routing_priority = None
+ self._requested_routing_skill_ids = None
@property
def event_time(self) -> int:
@@ -506,7 +515,7 @@ def message_type(self, message_type: str) -> None:
"""
if isinstance(message_type, int):
message_type = str(message_type)
- allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM"]
+ allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM", "APPLE"]
if message_type.lower() not in map(str.lower, allowed_values):
# print("Invalid value for message_type -> " + message_type)
self._message_type = "outdated_sdk_version"
@@ -609,6 +618,78 @@ def conversation_external_organization_ids(self, conversation_external_organizat
self._conversation_external_organization_ids = conversation_external_organization_ids
+ @property
+ def utilization_label(self) -> str:
+ """
+ Gets the utilization_label of this AcdStartDetailEventTopicAcdStartEvent.
+
+
+ :return: The utilization_label of this AcdStartDetailEventTopicAcdStartEvent.
+ :rtype: str
+ """
+ return self._utilization_label
+
+ @utilization_label.setter
+ def utilization_label(self, utilization_label: str) -> None:
+ """
+ Sets the utilization_label of this AcdStartDetailEventTopicAcdStartEvent.
+
+
+ :param utilization_label: The utilization_label of this AcdStartDetailEventTopicAcdStartEvent.
+ :type: str
+ """
+
+
+ self._utilization_label = utilization_label
+
+ @property
+ def routing_priority(self) -> int:
+ """
+ Gets the routing_priority of this AcdStartDetailEventTopicAcdStartEvent.
+
+
+ :return: The routing_priority of this AcdStartDetailEventTopicAcdStartEvent.
+ :rtype: int
+ """
+ return self._routing_priority
+
+ @routing_priority.setter
+ def routing_priority(self, routing_priority: int) -> None:
+ """
+ Sets the routing_priority of this AcdStartDetailEventTopicAcdStartEvent.
+
+
+ :param routing_priority: The routing_priority of this AcdStartDetailEventTopicAcdStartEvent.
+ :type: int
+ """
+
+
+ self._routing_priority = routing_priority
+
+ @property
+ def requested_routing_skill_ids(self) -> List[str]:
+ """
+ Gets the requested_routing_skill_ids of this AcdStartDetailEventTopicAcdStartEvent.
+
+
+ :return: The requested_routing_skill_ids of this AcdStartDetailEventTopicAcdStartEvent.
+ :rtype: list[str]
+ """
+ return self._requested_routing_skill_ids
+
+ @requested_routing_skill_ids.setter
+ def requested_routing_skill_ids(self, requested_routing_skill_ids: List[str]) -> None:
+ """
+ Sets the requested_routing_skill_ids of this AcdStartDetailEventTopicAcdStartEvent.
+
+
+ :param requested_routing_skill_ids: The requested_routing_skill_ids of this AcdStartDetailEventTopicAcdStartEvent.
+ :type: list[str]
+ """
+
+
+ self._requested_routing_skill_ids = requested_routing_skill_ids
+
def to_dict(self):
"""
Returns the model properties as a dict
diff --git a/build/PureCloudPlatformClientV2/models/action_certificate_listing.py b/build/PureCloudPlatformClientV2/models/action_certificate_listing.py
index a9bc51fb3..a9bc93fbb 100644
--- a/build/PureCloudPlatformClientV2/models/action_certificate_listing.py
+++ b/build/PureCloudPlatformClientV2/models/action_certificate_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ActionCertificateListing.
+ Gets the first_uri of this ActionCertificateListing.
- :return: The last_uri of this ActionCertificateListing.
+ :return: The first_uri of this ActionCertificateListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ActionCertificateListing.
+ Sets the first_uri of this ActionCertificateListing.
- :param last_uri: The last_uri of this ActionCertificateListing.
+ :param first_uri: The first_uri of this ActionCertificateListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ActionCertificateListing.
+ Gets the last_uri of this ActionCertificateListing.
- :return: The first_uri of this ActionCertificateListing.
+ :return: The last_uri of this ActionCertificateListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ActionCertificateListing.
+ Sets the last_uri of this ActionCertificateListing.
- :param first_uri: The first_uri of this ActionCertificateListing.
+ :param last_uri: The last_uri of this ActionCertificateListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/action_entity_listing.py b/build/PureCloudPlatformClientV2/models/action_entity_listing.py
index e26b91712..70b80ac69 100644
--- a/build/PureCloudPlatformClientV2/models/action_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/action_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ActionEntityListing.
+ Gets the first_uri of this ActionEntityListing.
- :return: The last_uri of this ActionEntityListing.
+ :return: The first_uri of this ActionEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ActionEntityListing.
+ Sets the first_uri of this ActionEntityListing.
- :param last_uri: The last_uri of this ActionEntityListing.
+ :param first_uri: The first_uri of this ActionEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ActionEntityListing.
+ Gets the last_uri of this ActionEntityListing.
- :return: The first_uri of this ActionEntityListing.
+ :return: The last_uri of this ActionEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ActionEntityListing.
+ Sets the last_uri of this ActionEntityListing.
- :param first_uri: The first_uri of this ActionEntityListing.
+ :param last_uri: The last_uri of this ActionEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/action_map_listing.py b/build/PureCloudPlatformClientV2/models/action_map_listing.py
index 6ee9d38c1..6b9e39c44 100644
--- a/build/PureCloudPlatformClientV2/models/action_map_listing.py
+++ b/build/PureCloudPlatformClientV2/models/action_map_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ActionMapListing.
+ Gets the first_uri of this ActionMapListing.
- :return: The last_uri of this ActionMapListing.
+ :return: The first_uri of this ActionMapListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ActionMapListing.
+ Sets the first_uri of this ActionMapListing.
- :param last_uri: The last_uri of this ActionMapListing.
+ :param first_uri: The first_uri of this ActionMapListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ActionMapListing.
+ Gets the last_uri of this ActionMapListing.
- :return: The first_uri of this ActionMapListing.
+ :return: The last_uri of this ActionMapListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ActionMapListing.
+ Sets the last_uri of this ActionMapListing.
- :param first_uri: The first_uri of this ActionMapListing.
+ :param last_uri: The last_uri of this ActionMapListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/action_target_listing.py b/build/PureCloudPlatformClientV2/models/action_target_listing.py
index 32402324b..f62d3923c 100644
--- a/build/PureCloudPlatformClientV2/models/action_target_listing.py
+++ b/build/PureCloudPlatformClientV2/models/action_target_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ActionTargetListing.
+ Gets the first_uri of this ActionTargetListing.
- :return: The last_uri of this ActionTargetListing.
+ :return: The first_uri of this ActionTargetListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ActionTargetListing.
+ Sets the first_uri of this ActionTargetListing.
- :param last_uri: The last_uri of this ActionTargetListing.
+ :param first_uri: The first_uri of this ActionTargetListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ActionTargetListing.
+ Gets the last_uri of this ActionTargetListing.
- :return: The first_uri of this ActionTargetListing.
+ :return: The last_uri of this ActionTargetListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ActionTargetListing.
+ Sets the last_uri of this ActionTargetListing.
- :param first_uri: The first_uri of this ActionTargetListing.
+ :param last_uri: The last_uri of this ActionTargetListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/action_template_listing.py b/build/PureCloudPlatformClientV2/models/action_template_listing.py
index 997028daa..bbac03e1f 100644
--- a/build/PureCloudPlatformClientV2/models/action_template_listing.py
+++ b/build/PureCloudPlatformClientV2/models/action_template_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ActionTemplateListing.
+ Gets the first_uri of this ActionTemplateListing.
- :return: The last_uri of this ActionTemplateListing.
+ :return: The first_uri of this ActionTemplateListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ActionTemplateListing.
+ Sets the first_uri of this ActionTemplateListing.
- :param last_uri: The last_uri of this ActionTemplateListing.
+ :param first_uri: The first_uri of this ActionTemplateListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ActionTemplateListing.
+ Gets the last_uri of this ActionTemplateListing.
- :return: The first_uri of this ActionTemplateListing.
+ :return: The last_uri of this ActionTemplateListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ActionTemplateListing.
+ Sets the last_uri of this ActionTemplateListing.
- :param first_uri: The first_uri of this ActionTemplateListing.
+ :param last_uri: The last_uri of this ActionTemplateListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/activity_codes_reference.py b/build/PureCloudPlatformClientV2/models/activity_codes_reference.py
index fdeba783c..2a5301847 100644
--- a/build/PureCloudPlatformClientV2/models/activity_codes_reference.py
+++ b/build/PureCloudPlatformClientV2/models/activity_codes_reference.py
@@ -48,45 +48,18 @@ def __init__(self) -> None:
and the value is json key in definition.
"""
self.swagger_types = {
- 'id': 'str',
'ids': 'list[str]',
'self_uri': 'str'
}
self.attribute_map = {
- 'id': 'id',
'ids': 'ids',
'self_uri': 'selfUri'
}
- self._id = None
self._ids = None
self._self_uri = None
- @property
- def id(self) -> str:
- """
- Gets the id of this ActivityCodesReference.
- The globally unique identifier for the object.
-
- :return: The id of this ActivityCodesReference.
- :rtype: str
- """
- return self._id
-
- @id.setter
- def id(self, id: str) -> None:
- """
- Sets the id of this ActivityCodesReference.
- The globally unique identifier for the object.
-
- :param id: The id of this ActivityCodesReference.
- :type: str
- """
-
-
- self._id = id
-
@property
def ids(self) -> List[str]:
"""
diff --git a/build/PureCloudPlatformClientV2/models/acw_detail_event_topic_after_call_work_event.py b/build/PureCloudPlatformClientV2/models/acw_detail_event_topic_after_call_work_event.py
index 395a17d27..44df0419f 100644
--- a/build/PureCloudPlatformClientV2/models/acw_detail_event_topic_after_call_work_event.py
+++ b/build/PureCloudPlatformClientV2/models/acw_detail_event_topic_after_call_work_event.py
@@ -515,7 +515,7 @@ def message_type(self, message_type: str) -> None:
"""
if isinstance(message_type, int):
message_type = str(message_type)
- allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM"]
+ allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM", "APPLE"]
if message_type.lower() not in map(str.lower, allowed_values):
# print("Invalid value for message_type -> " + message_type)
self._message_type = "outdated_sdk_version"
diff --git a/build/PureCloudPlatformClientV2/models/agent_activity_entity_listing.py b/build/PureCloudPlatformClientV2/models/agent_activity_entity_listing.py
index 866871e66..afff84741 100644
--- a/build/PureCloudPlatformClientV2/models/agent_activity_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/agent_activity_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this AgentActivityEntityListing.
+ Gets the first_uri of this AgentActivityEntityListing.
- :return: The last_uri of this AgentActivityEntityListing.
+ :return: The first_uri of this AgentActivityEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this AgentActivityEntityListing.
+ Sets the first_uri of this AgentActivityEntityListing.
- :param last_uri: The last_uri of this AgentActivityEntityListing.
+ :param first_uri: The first_uri of this AgentActivityEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this AgentActivityEntityListing.
+ Gets the last_uri of this AgentActivityEntityListing.
- :return: The first_uri of this AgentActivityEntityListing.
+ :return: The last_uri of this AgentActivityEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this AgentActivityEntityListing.
+ Sets the last_uri of this AgentActivityEntityListing.
- :param first_uri: The first_uri of this AgentActivityEntityListing.
+ :param last_uri: The last_uri of this AgentActivityEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/alert_listing.py b/build/PureCloudPlatformClientV2/models/alert_listing.py
index 726684d30..cbb3b5f43 100644
--- a/build/PureCloudPlatformClientV2/models/alert_listing.py
+++ b/build/PureCloudPlatformClientV2/models/alert_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this AlertListing.
+ Gets the first_uri of this AlertListing.
- :return: The last_uri of this AlertListing.
+ :return: The first_uri of this AlertListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this AlertListing.
+ Sets the first_uri of this AlertListing.
- :param last_uri: The last_uri of this AlertListing.
+ :param first_uri: The first_uri of this AlertListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this AlertListing.
+ Gets the last_uri of this AlertListing.
- :return: The first_uri of this AlertListing.
+ :return: The last_uri of this AlertListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this AlertListing.
+ Sets the last_uri of this AlertListing.
- :param first_uri: The first_uri of this AlertListing.
+ :param last_uri: The last_uri of this AlertListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/answer_generation_config.py b/build/PureCloudPlatformClientV2/models/answer_generation_config.py
new file mode 100644
index 000000000..a70b8f84c
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/answer_generation_config.py
@@ -0,0 +1,139 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+
+class AnswerGenerationConfig(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ AnswerGenerationConfig - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'enabled': 'bool'
+ }
+
+ self.attribute_map = {
+ 'enabled': 'enabled'
+ }
+
+ self._enabled = None
+
+ @property
+ def enabled(self) -> bool:
+ """
+ Gets the enabled of this AnswerGenerationConfig.
+ Answer generation is enabled.
+
+ :return: The enabled of this AnswerGenerationConfig.
+ :rtype: bool
+ """
+ return self._enabled
+
+ @enabled.setter
+ def enabled(self, enabled: bool) -> None:
+ """
+ Sets the enabled of this AnswerGenerationConfig.
+ Answer generation is enabled.
+
+ :param enabled: The enabled of this AnswerGenerationConfig.
+ :type: bool
+ """
+
+
+ self._enabled = enabled
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/assigned_learning_module_domain_entity_listing.py b/build/PureCloudPlatformClientV2/models/assigned_learning_module_domain_entity_listing.py
index 58b0d2d56..fa1f85520 100644
--- a/build/PureCloudPlatformClientV2/models/assigned_learning_module_domain_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/assigned_learning_module_domain_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this AssignedLearningModuleDomainEntityListing.
+ Gets the first_uri of this AssignedLearningModuleDomainEntityListing.
- :return: The last_uri of this AssignedLearningModuleDomainEntityListing.
+ :return: The first_uri of this AssignedLearningModuleDomainEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this AssignedLearningModuleDomainEntityListing.
+ Sets the first_uri of this AssignedLearningModuleDomainEntityListing.
- :param last_uri: The last_uri of this AssignedLearningModuleDomainEntityListing.
+ :param first_uri: The first_uri of this AssignedLearningModuleDomainEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this AssignedLearningModuleDomainEntityListing.
+ Gets the last_uri of this AssignedLearningModuleDomainEntityListing.
- :return: The first_uri of this AssignedLearningModuleDomainEntityListing.
+ :return: The last_uri of this AssignedLearningModuleDomainEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this AssignedLearningModuleDomainEntityListing.
+ Sets the last_uri of this AssignedLearningModuleDomainEntityListing.
- :param first_uri: The first_uri of this AssignedLearningModuleDomainEntityListing.
+ :param last_uri: The last_uri of this AssignedLearningModuleDomainEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/assistant.py b/build/PureCloudPlatformClientV2/models/assistant.py
new file mode 100644
index 000000000..94dece245
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/assistant.py
@@ -0,0 +1,447 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import Copilot
+ from . import GoogleDialogflowConfig
+ from . import KnowledgeSuggestionConfig
+ from . import TranscriptionConfig
+ from . import UserReference
+
+class Assistant(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ Assistant - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'id': 'str',
+ 'name': 'str',
+ 'date_created': 'datetime',
+ 'date_modified': 'datetime',
+ 'created_by': 'UserReference',
+ 'modified_by': 'UserReference',
+ 'google_dialogflow_config': 'GoogleDialogflowConfig',
+ 'transcription_config': 'TranscriptionConfig',
+ 'knowledge_suggestion_config': 'KnowledgeSuggestionConfig',
+ 'state': 'str',
+ 'copilot': 'Copilot',
+ 'self_uri': 'str'
+ }
+
+ self.attribute_map = {
+ 'id': 'id',
+ 'name': 'name',
+ 'date_created': 'dateCreated',
+ 'date_modified': 'dateModified',
+ 'created_by': 'createdBy',
+ 'modified_by': 'modifiedBy',
+ 'google_dialogflow_config': 'googleDialogflowConfig',
+ 'transcription_config': 'transcriptionConfig',
+ 'knowledge_suggestion_config': 'knowledgeSuggestionConfig',
+ 'state': 'state',
+ 'copilot': 'copilot',
+ 'self_uri': 'selfUri'
+ }
+
+ self._id = None
+ self._name = None
+ self._date_created = None
+ self._date_modified = None
+ self._created_by = None
+ self._modified_by = None
+ self._google_dialogflow_config = None
+ self._transcription_config = None
+ self._knowledge_suggestion_config = None
+ self._state = None
+ self._copilot = None
+ self._self_uri = None
+
+ @property
+ def id(self) -> str:
+ """
+ Gets the id of this Assistant.
+ The globally unique identifier for the object.
+
+ :return: The id of this Assistant.
+ :rtype: str
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id: str) -> None:
+ """
+ Sets the id of this Assistant.
+ The globally unique identifier for the object.
+
+ :param id: The id of this Assistant.
+ :type: str
+ """
+
+
+ self._id = id
+
+ @property
+ def name(self) -> str:
+ """
+ Gets the name of this Assistant.
+ The name of the assistant that will assist the agent.
+
+ :return: The name of this Assistant.
+ :rtype: str
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name: str) -> None:
+ """
+ Sets the name of this Assistant.
+ The name of the assistant that will assist the agent.
+
+ :param name: The name of this Assistant.
+ :type: str
+ """
+
+
+ self._name = name
+
+ @property
+ def date_created(self) -> datetime:
+ """
+ Gets the date_created of this Assistant.
+ Date when the assistant was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
+
+ :return: The date_created of this Assistant.
+ :rtype: datetime
+ """
+ return self._date_created
+
+ @date_created.setter
+ def date_created(self, date_created: datetime) -> None:
+ """
+ Sets the date_created of this Assistant.
+ Date when the assistant was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
+
+ :param date_created: The date_created of this Assistant.
+ :type: datetime
+ """
+
+
+ self._date_created = date_created
+
+ @property
+ def date_modified(self) -> datetime:
+ """
+ Gets the date_modified of this Assistant.
+ 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
+
+ :return: The date_modified of this Assistant.
+ :rtype: datetime
+ """
+ return self._date_modified
+
+ @date_modified.setter
+ def date_modified(self, date_modified: datetime) -> None:
+ """
+ Sets the date_modified of this Assistant.
+ 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
+
+ :param date_modified: The date_modified of this Assistant.
+ :type: datetime
+ """
+
+
+ self._date_modified = date_modified
+
+ @property
+ def created_by(self) -> 'UserReference':
+ """
+ Gets the created_by of this Assistant.
+ The user who created the assistant.
+
+ :return: The created_by of this Assistant.
+ :rtype: UserReference
+ """
+ return self._created_by
+
+ @created_by.setter
+ def created_by(self, created_by: 'UserReference') -> None:
+ """
+ Sets the created_by of this Assistant.
+ The user who created the assistant.
+
+ :param created_by: The created_by of this Assistant.
+ :type: UserReference
+ """
+
+
+ self._created_by = created_by
+
+ @property
+ def modified_by(self) -> 'UserReference':
+ """
+ Gets the modified_by of this Assistant.
+ The user who last modified the assistant.
+
+ :return: The modified_by of this Assistant.
+ :rtype: UserReference
+ """
+ return self._modified_by
+
+ @modified_by.setter
+ def modified_by(self, modified_by: 'UserReference') -> None:
+ """
+ Sets the modified_by of this Assistant.
+ The user who last modified the assistant.
+
+ :param modified_by: The modified_by of this Assistant.
+ :type: UserReference
+ """
+
+
+ self._modified_by = modified_by
+
+ @property
+ def google_dialogflow_config(self) -> 'GoogleDialogflowConfig':
+ """
+ Gets the google_dialogflow_config of this Assistant.
+ Configuration of Dialogflow used to assist the agent with transcriptions and knowledge suggestions.
+
+ :return: The google_dialogflow_config of this Assistant.
+ :rtype: GoogleDialogflowConfig
+ """
+ return self._google_dialogflow_config
+
+ @google_dialogflow_config.setter
+ def google_dialogflow_config(self, google_dialogflow_config: 'GoogleDialogflowConfig') -> None:
+ """
+ Sets the google_dialogflow_config of this Assistant.
+ Configuration of Dialogflow used to assist the agent with transcriptions and knowledge suggestions.
+
+ :param google_dialogflow_config: The google_dialogflow_config of this Assistant.
+ :type: GoogleDialogflowConfig
+ """
+
+
+ self._google_dialogflow_config = google_dialogflow_config
+
+ @property
+ def transcription_config(self) -> 'TranscriptionConfig':
+ """
+ Gets the transcription_config of this Assistant.
+ Configuration for speech transcription used to assist the agent.
+
+ :return: The transcription_config of this Assistant.
+ :rtype: TranscriptionConfig
+ """
+ return self._transcription_config
+
+ @transcription_config.setter
+ def transcription_config(self, transcription_config: 'TranscriptionConfig') -> None:
+ """
+ Sets the transcription_config of this Assistant.
+ Configuration for speech transcription used to assist the agent.
+
+ :param transcription_config: The transcription_config of this Assistant.
+ :type: TranscriptionConfig
+ """
+
+
+ self._transcription_config = transcription_config
+
+ @property
+ def knowledge_suggestion_config(self) -> 'KnowledgeSuggestionConfig':
+ """
+ Gets the knowledge_suggestion_config of this Assistant.
+ Configuration that defines how to produce knowledge suggestions.
+
+ :return: The knowledge_suggestion_config of this Assistant.
+ :rtype: KnowledgeSuggestionConfig
+ """
+ return self._knowledge_suggestion_config
+
+ @knowledge_suggestion_config.setter
+ def knowledge_suggestion_config(self, knowledge_suggestion_config: 'KnowledgeSuggestionConfig') -> None:
+ """
+ Sets the knowledge_suggestion_config of this Assistant.
+ Configuration that defines how to produce knowledge suggestions.
+
+ :param knowledge_suggestion_config: The knowledge_suggestion_config of this Assistant.
+ :type: KnowledgeSuggestionConfig
+ """
+
+
+ self._knowledge_suggestion_config = knowledge_suggestion_config
+
+ @property
+ def state(self) -> str:
+ """
+ Gets the state of this Assistant.
+ State of the assistant.
+
+ :return: The state of this Assistant.
+ :rtype: str
+ """
+ return self._state
+
+ @state.setter
+ def state(self, state: str) -> None:
+ """
+ Sets the state of this Assistant.
+ State of the assistant.
+
+ :param state: The state of this Assistant.
+ :type: str
+ """
+ if isinstance(state, int):
+ state = str(state)
+ allowed_values = ["Active", "Inactive"]
+ if state.lower() not in map(str.lower, allowed_values):
+ # print("Invalid value for state -> " + state)
+ self._state = "outdated_sdk_version"
+ else:
+ self._state = state
+
+ @property
+ def copilot(self) -> 'Copilot':
+ """
+ Gets the copilot of this Assistant.
+ Agent copilot configuration.
+
+ :return: The copilot of this Assistant.
+ :rtype: Copilot
+ """
+ return self._copilot
+
+ @copilot.setter
+ def copilot(self, copilot: 'Copilot') -> None:
+ """
+ Sets the copilot of this Assistant.
+ Agent copilot configuration.
+
+ :param copilot: The copilot of this Assistant.
+ :type: Copilot
+ """
+
+
+ self._copilot = copilot
+
+ @property
+ def self_uri(self) -> str:
+ """
+ Gets the self_uri of this Assistant.
+ The URI for this object
+
+ :return: The self_uri of this Assistant.
+ :rtype: str
+ """
+ return self._self_uri
+
+ @self_uri.setter
+ def self_uri(self, self_uri: str) -> None:
+ """
+ Sets the self_uri of this Assistant.
+ The URI for this object
+
+ :param self_uri: The self_uri of this Assistant.
+ :type: str
+ """
+
+
+ self._self_uri = self_uri
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/assistant_listing.py b/build/PureCloudPlatformClientV2/models/assistant_listing.py
new file mode 100644
index 000000000..759270f01
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/assistant_listing.py
@@ -0,0 +1,222 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import Assistant
+
+class AssistantListing(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ AssistantListing - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'entities': 'list[Assistant]',
+ 'next_uri': 'str',
+ 'self_uri': 'str',
+ 'previous_uri': 'str'
+ }
+
+ self.attribute_map = {
+ 'entities': 'entities',
+ 'next_uri': 'nextUri',
+ 'self_uri': 'selfUri',
+ 'previous_uri': 'previousUri'
+ }
+
+ self._entities = None
+ self._next_uri = None
+ self._self_uri = None
+ self._previous_uri = None
+
+ @property
+ def entities(self) -> List['Assistant']:
+ """
+ Gets the entities of this AssistantListing.
+
+
+ :return: The entities of this AssistantListing.
+ :rtype: list[Assistant]
+ """
+ return self._entities
+
+ @entities.setter
+ def entities(self, entities: List['Assistant']) -> None:
+ """
+ Sets the entities of this AssistantListing.
+
+
+ :param entities: The entities of this AssistantListing.
+ :type: list[Assistant]
+ """
+
+
+ self._entities = entities
+
+ @property
+ def next_uri(self) -> str:
+ """
+ Gets the next_uri of this AssistantListing.
+
+
+ :return: The next_uri of this AssistantListing.
+ :rtype: str
+ """
+ return self._next_uri
+
+ @next_uri.setter
+ def next_uri(self, next_uri: str) -> None:
+ """
+ Sets the next_uri of this AssistantListing.
+
+
+ :param next_uri: The next_uri of this AssistantListing.
+ :type: str
+ """
+
+
+ self._next_uri = next_uri
+
+ @property
+ def self_uri(self) -> str:
+ """
+ Gets the self_uri of this AssistantListing.
+
+
+ :return: The self_uri of this AssistantListing.
+ :rtype: str
+ """
+ return self._self_uri
+
+ @self_uri.setter
+ def self_uri(self, self_uri: str) -> None:
+ """
+ Sets the self_uri of this AssistantListing.
+
+
+ :param self_uri: The self_uri of this AssistantListing.
+ :type: str
+ """
+
+
+ self._self_uri = self_uri
+
+ @property
+ def previous_uri(self) -> str:
+ """
+ Gets the previous_uri of this AssistantListing.
+
+
+ :return: The previous_uri of this AssistantListing.
+ :rtype: str
+ """
+ return self._previous_uri
+
+ @previous_uri.setter
+ def previous_uri(self, previous_uri: str) -> None:
+ """
+ Sets the previous_uri of this AssistantListing.
+
+
+ :param previous_uri: The previous_uri of this AssistantListing.
+ :type: str
+ """
+
+
+ self._previous_uri = previous_uri
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/assistant_queue.py b/build/PureCloudPlatformClientV2/models/assistant_queue.py
new file mode 100644
index 000000000..d255e121b
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/assistant_queue.py
@@ -0,0 +1,276 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import Assistant
+
+class AssistantQueue(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ AssistantQueue - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'id': 'str',
+ 'media_types': 'list[str]',
+ 'assistant': 'Assistant',
+ 'date_created': 'datetime',
+ 'date_modified': 'datetime',
+ 'self_uri': 'str'
+ }
+
+ self.attribute_map = {
+ 'id': 'id',
+ 'media_types': 'mediaTypes',
+ 'assistant': 'assistant',
+ 'date_created': 'dateCreated',
+ 'date_modified': 'dateModified',
+ 'self_uri': 'selfUri'
+ }
+
+ self._id = None
+ self._media_types = None
+ self._assistant = None
+ self._date_created = None
+ self._date_modified = None
+ self._self_uri = None
+
+ @property
+ def id(self) -> str:
+ """
+ Gets the id of this AssistantQueue.
+ The globally unique identifier for the queue.
+
+ :return: The id of this AssistantQueue.
+ :rtype: str
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id: str) -> None:
+ """
+ Sets the id of this AssistantQueue.
+ The globally unique identifier for the queue.
+
+ :param id: The id of this AssistantQueue.
+ :type: str
+ """
+
+
+ self._id = id
+
+ @property
+ def media_types(self) -> List[str]:
+ """
+ Gets the media_types of this AssistantQueue.
+ List of media Types in which the assistant is activated for this queue.
+
+ :return: The media_types of this AssistantQueue.
+ :rtype: list[str]
+ """
+ return self._media_types
+
+ @media_types.setter
+ def media_types(self, media_types: List[str]) -> None:
+ """
+ Sets the media_types of this AssistantQueue.
+ List of media Types in which the assistant is activated for this queue.
+
+ :param media_types: The media_types of this AssistantQueue.
+ :type: list[str]
+ """
+
+
+ self._media_types = media_types
+
+ @property
+ def assistant(self) -> 'Assistant':
+ """
+ Gets the assistant of this AssistantQueue.
+ Assistant to which the queue is assigned.
+
+ :return: The assistant of this AssistantQueue.
+ :rtype: Assistant
+ """
+ return self._assistant
+
+ @assistant.setter
+ def assistant(self, assistant: 'Assistant') -> None:
+ """
+ Sets the assistant of this AssistantQueue.
+ Assistant to which the queue is assigned.
+
+ :param assistant: The assistant of this AssistantQueue.
+ :type: Assistant
+ """
+
+
+ self._assistant = assistant
+
+ @property
+ def date_created(self) -> datetime:
+ """
+ Gets the date_created of this AssistantQueue.
+ 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
+
+ :return: The date_created of this AssistantQueue.
+ :rtype: datetime
+ """
+ return self._date_created
+
+ @date_created.setter
+ def date_created(self, date_created: datetime) -> None:
+ """
+ Sets the date_created of this AssistantQueue.
+ 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
+
+ :param date_created: The date_created of this AssistantQueue.
+ :type: datetime
+ """
+
+
+ self._date_created = date_created
+
+ @property
+ def date_modified(self) -> datetime:
+ """
+ Gets the date_modified of this AssistantQueue.
+ 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
+
+ :return: The date_modified of this AssistantQueue.
+ :rtype: datetime
+ """
+ return self._date_modified
+
+ @date_modified.setter
+ def date_modified(self, date_modified: datetime) -> None:
+ """
+ Sets the date_modified of this AssistantQueue.
+ 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
+
+ :param date_modified: The date_modified of this AssistantQueue.
+ :type: datetime
+ """
+
+
+ self._date_modified = date_modified
+
+ @property
+ def self_uri(self) -> str:
+ """
+ Gets the self_uri of this AssistantQueue.
+ The URI for this object
+
+ :return: The self_uri of this AssistantQueue.
+ :rtype: str
+ """
+ return self._self_uri
+
+ @self_uri.setter
+ def self_uri(self, self_uri: str) -> None:
+ """
+ Sets the self_uri of this AssistantQueue.
+ The URI for this object
+
+ :param self_uri: The self_uri of this AssistantQueue.
+ :type: str
+ """
+
+
+ self._self_uri = self_uri
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/assistant_queue_listing.py b/build/PureCloudPlatformClientV2/models/assistant_queue_listing.py
new file mode 100644
index 000000000..a57a48ba8
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/assistant_queue_listing.py
@@ -0,0 +1,222 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import AssistantQueue
+
+class AssistantQueueListing(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ AssistantQueueListing - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'entities': 'list[AssistantQueue]',
+ 'next_uri': 'str',
+ 'self_uri': 'str',
+ 'previous_uri': 'str'
+ }
+
+ self.attribute_map = {
+ 'entities': 'entities',
+ 'next_uri': 'nextUri',
+ 'self_uri': 'selfUri',
+ 'previous_uri': 'previousUri'
+ }
+
+ self._entities = None
+ self._next_uri = None
+ self._self_uri = None
+ self._previous_uri = None
+
+ @property
+ def entities(self) -> List['AssistantQueue']:
+ """
+ Gets the entities of this AssistantQueueListing.
+
+
+ :return: The entities of this AssistantQueueListing.
+ :rtype: list[AssistantQueue]
+ """
+ return self._entities
+
+ @entities.setter
+ def entities(self, entities: List['AssistantQueue']) -> None:
+ """
+ Sets the entities of this AssistantQueueListing.
+
+
+ :param entities: The entities of this AssistantQueueListing.
+ :type: list[AssistantQueue]
+ """
+
+
+ self._entities = entities
+
+ @property
+ def next_uri(self) -> str:
+ """
+ Gets the next_uri of this AssistantQueueListing.
+
+
+ :return: The next_uri of this AssistantQueueListing.
+ :rtype: str
+ """
+ return self._next_uri
+
+ @next_uri.setter
+ def next_uri(self, next_uri: str) -> None:
+ """
+ Sets the next_uri of this AssistantQueueListing.
+
+
+ :param next_uri: The next_uri of this AssistantQueueListing.
+ :type: str
+ """
+
+
+ self._next_uri = next_uri
+
+ @property
+ def self_uri(self) -> str:
+ """
+ Gets the self_uri of this AssistantQueueListing.
+
+
+ :return: The self_uri of this AssistantQueueListing.
+ :rtype: str
+ """
+ return self._self_uri
+
+ @self_uri.setter
+ def self_uri(self, self_uri: str) -> None:
+ """
+ Sets the self_uri of this AssistantQueueListing.
+
+
+ :param self_uri: The self_uri of this AssistantQueueListing.
+ :type: str
+ """
+
+
+ self._self_uri = self_uri
+
+ @property
+ def previous_uri(self) -> str:
+ """
+ Gets the previous_uri of this AssistantQueueListing.
+
+
+ :return: The previous_uri of this AssistantQueueListing.
+ :rtype: str
+ """
+ return self._previous_uri
+
+ @previous_uri.setter
+ def previous_uri(self, previous_uri: str) -> None:
+ """
+ Sets the previous_uri of this AssistantQueueListing.
+
+
+ :param previous_uri: The previous_uri of this AssistantQueueListing.
+ :type: str
+ """
+
+
+ self._previous_uri = previous_uri
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/attempt_limits_entity_listing.py b/build/PureCloudPlatformClientV2/models/attempt_limits_entity_listing.py
index ae3d14e7f..6b4846a45 100644
--- a/build/PureCloudPlatformClientV2/models/attempt_limits_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/attempt_limits_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this AttemptLimitsEntityListing.
+ Gets the first_uri of this AttemptLimitsEntityListing.
- :return: The last_uri of this AttemptLimitsEntityListing.
+ :return: The first_uri of this AttemptLimitsEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this AttemptLimitsEntityListing.
+ Sets the first_uri of this AttemptLimitsEntityListing.
- :param last_uri: The last_uri of this AttemptLimitsEntityListing.
+ :param first_uri: The first_uri of this AttemptLimitsEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this AttemptLimitsEntityListing.
+ Gets the last_uri of this AttemptLimitsEntityListing.
- :return: The first_uri of this AttemptLimitsEntityListing.
+ :return: The last_uri of this AttemptLimitsEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this AttemptLimitsEntityListing.
+ Sets the last_uri of this AttemptLimitsEntityListing.
- :param first_uri: The first_uri of this AttemptLimitsEntityListing.
+ :param last_uri: The last_uri of this AttemptLimitsEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/authz_division_entity_listing.py b/build/PureCloudPlatformClientV2/models/authz_division_entity_listing.py
index 3f3e53511..ed9f3c4b8 100644
--- a/build/PureCloudPlatformClientV2/models/authz_division_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/authz_division_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this AuthzDivisionEntityListing.
+ Gets the first_uri of this AuthzDivisionEntityListing.
- :return: The last_uri of this AuthzDivisionEntityListing.
+ :return: The first_uri of this AuthzDivisionEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this AuthzDivisionEntityListing.
+ Sets the first_uri of this AuthzDivisionEntityListing.
- :param last_uri: The last_uri of this AuthzDivisionEntityListing.
+ :param first_uri: The first_uri of this AuthzDivisionEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this AuthzDivisionEntityListing.
+ Gets the last_uri of this AuthzDivisionEntityListing.
- :return: The first_uri of this AuthzDivisionEntityListing.
+ :return: The last_uri of this AuthzDivisionEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this AuthzDivisionEntityListing.
+ Sets the last_uri of this AuthzDivisionEntityListing.
- :param first_uri: The first_uri of this AuthzDivisionEntityListing.
+ :param last_uri: The last_uri of this AuthzDivisionEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/bot_connector_bot_summary_entity_listing.py b/build/PureCloudPlatformClientV2/models/bot_connector_bot_summary_entity_listing.py
index dd64cb03d..edd8fb3b3 100644
--- a/build/PureCloudPlatformClientV2/models/bot_connector_bot_summary_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/bot_connector_bot_summary_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this BotConnectorBotSummaryEntityListing.
+ Gets the first_uri of this BotConnectorBotSummaryEntityListing.
- :return: The last_uri of this BotConnectorBotSummaryEntityListing.
+ :return: The first_uri of this BotConnectorBotSummaryEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this BotConnectorBotSummaryEntityListing.
+ Sets the first_uri of this BotConnectorBotSummaryEntityListing.
- :param last_uri: The last_uri of this BotConnectorBotSummaryEntityListing.
+ :param first_uri: The first_uri of this BotConnectorBotSummaryEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this BotConnectorBotSummaryEntityListing.
+ Gets the last_uri of this BotConnectorBotSummaryEntityListing.
- :return: The first_uri of this BotConnectorBotSummaryEntityListing.
+ :return: The last_uri of this BotConnectorBotSummaryEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this BotConnectorBotSummaryEntityListing.
+ Sets the last_uri of this BotConnectorBotSummaryEntityListing.
- :param first_uri: The first_uri of this BotConnectorBotSummaryEntityListing.
+ :param last_uri: The last_uri of this BotConnectorBotSummaryEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/bot_connector_bot_version_summary_entity_listing.py b/build/PureCloudPlatformClientV2/models/bot_connector_bot_version_summary_entity_listing.py
index 018ca1965..8e3c0e4dc 100644
--- a/build/PureCloudPlatformClientV2/models/bot_connector_bot_version_summary_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/bot_connector_bot_version_summary_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this BotConnectorBotVersionSummaryEntityListing.
+ Gets the first_uri of this BotConnectorBotVersionSummaryEntityListing.
- :return: The last_uri of this BotConnectorBotVersionSummaryEntityListing.
+ :return: The first_uri of this BotConnectorBotVersionSummaryEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this BotConnectorBotVersionSummaryEntityListing.
+ Sets the first_uri of this BotConnectorBotVersionSummaryEntityListing.
- :param last_uri: The last_uri of this BotConnectorBotVersionSummaryEntityListing.
+ :param first_uri: The first_uri of this BotConnectorBotVersionSummaryEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this BotConnectorBotVersionSummaryEntityListing.
+ Gets the last_uri of this BotConnectorBotVersionSummaryEntityListing.
- :return: The first_uri of this BotConnectorBotVersionSummaryEntityListing.
+ :return: The last_uri of this BotConnectorBotVersionSummaryEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this BotConnectorBotVersionSummaryEntityListing.
+ Sets the last_uri of this BotConnectorBotVersionSummaryEntityListing.
- :param first_uri: The first_uri of this BotConnectorBotVersionSummaryEntityListing.
+ :param last_uri: The last_uri of this BotConnectorBotVersionSummaryEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/bu_activity_settings_request.py b/build/PureCloudPlatformClientV2/models/bu_activity_settings_request.py
new file mode 100644
index 000000000..6bd2f6c6e
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/bu_activity_settings_request.py
@@ -0,0 +1,139 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+
+class BuActivitySettingsRequest(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ BuActivitySettingsRequest - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'default_activity_code_id': 'str'
+ }
+
+ self.attribute_map = {
+ 'default_activity_code_id': 'defaultActivityCodeId'
+ }
+
+ self._default_activity_code_id = None
+
+ @property
+ def default_activity_code_id(self) -> str:
+ """
+ Gets the default_activity_code_id of this BuActivitySettingsRequest.
+ Default Activity Code ID settings
+
+ :return: The default_activity_code_id of this BuActivitySettingsRequest.
+ :rtype: str
+ """
+ return self._default_activity_code_id
+
+ @default_activity_code_id.setter
+ def default_activity_code_id(self, default_activity_code_id: str) -> None:
+ """
+ Sets the default_activity_code_id of this BuActivitySettingsRequest.
+ Default Activity Code ID settings
+
+ :param default_activity_code_id: The default_activity_code_id of this BuActivitySettingsRequest.
+ :type: str
+ """
+
+
+ self._default_activity_code_id = default_activity_code_id
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/bu_activity_settings_response.py b/build/PureCloudPlatformClientV2/models/bu_activity_settings_response.py
new file mode 100644
index 000000000..3e5fa1344
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/bu_activity_settings_response.py
@@ -0,0 +1,141 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import ActivityCodeReference
+
+class BuActivitySettingsResponse(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ BuActivitySettingsResponse - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'default_activity_code': 'ActivityCodeReference'
+ }
+
+ self.attribute_map = {
+ 'default_activity_code': 'defaultActivityCode'
+ }
+
+ self._default_activity_code = None
+
+ @property
+ def default_activity_code(self) -> 'ActivityCodeReference':
+ """
+ Gets the default_activity_code of this BuActivitySettingsResponse.
+ Default Activity Code settings
+
+ :return: The default_activity_code of this BuActivitySettingsResponse.
+ :rtype: ActivityCodeReference
+ """
+ return self._default_activity_code
+
+ @default_activity_code.setter
+ def default_activity_code(self, default_activity_code: 'ActivityCodeReference') -> None:
+ """
+ Sets the default_activity_code of this BuActivitySettingsResponse.
+ Default Activity Code settings
+
+ :param default_activity_code: The default_activity_code of this BuActivitySettingsResponse.
+ :type: ActivityCodeReference
+ """
+
+
+ self._default_activity_code = default_activity_code
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/bu_notification_settings_request.py b/build/PureCloudPlatformClientV2/models/bu_notification_settings_request.py
new file mode 100644
index 000000000..5adf1e6ca
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/bu_notification_settings_request.py
@@ -0,0 +1,141 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import BuScheduleNotificationsSettingsRequest
+
+class BuNotificationSettingsRequest(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ BuNotificationSettingsRequest - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'scheduling': 'BuScheduleNotificationsSettingsRequest'
+ }
+
+ self.attribute_map = {
+ 'scheduling': 'scheduling'
+ }
+
+ self._scheduling = None
+
+ @property
+ def scheduling(self) -> 'BuScheduleNotificationsSettingsRequest':
+ """
+ Gets the scheduling of this BuNotificationSettingsRequest.
+ Schedule notification settings
+
+ :return: The scheduling of this BuNotificationSettingsRequest.
+ :rtype: BuScheduleNotificationsSettingsRequest
+ """
+ return self._scheduling
+
+ @scheduling.setter
+ def scheduling(self, scheduling: 'BuScheduleNotificationsSettingsRequest') -> None:
+ """
+ Sets the scheduling of this BuNotificationSettingsRequest.
+ Schedule notification settings
+
+ :param scheduling: The scheduling of this BuNotificationSettingsRequest.
+ :type: BuScheduleNotificationsSettingsRequest
+ """
+
+
+ self._scheduling = scheduling
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/bu_notification_settings_response.py b/build/PureCloudPlatformClientV2/models/bu_notification_settings_response.py
new file mode 100644
index 000000000..34d7ab1ae
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/bu_notification_settings_response.py
@@ -0,0 +1,141 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import BuScheduleNotificationsSettingsResponse
+
+class BuNotificationSettingsResponse(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ BuNotificationSettingsResponse - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'scheduling': 'BuScheduleNotificationsSettingsResponse'
+ }
+
+ self.attribute_map = {
+ 'scheduling': 'scheduling'
+ }
+
+ self._scheduling = None
+
+ @property
+ def scheduling(self) -> 'BuScheduleNotificationsSettingsResponse':
+ """
+ Gets the scheduling of this BuNotificationSettingsResponse.
+ Schedule notification settings
+
+ :return: The scheduling of this BuNotificationSettingsResponse.
+ :rtype: BuScheduleNotificationsSettingsResponse
+ """
+ return self._scheduling
+
+ @scheduling.setter
+ def scheduling(self, scheduling: 'BuScheduleNotificationsSettingsResponse') -> None:
+ """
+ Sets the scheduling of this BuNotificationSettingsResponse.
+ Schedule notification settings
+
+ :param scheduling: The scheduling of this BuNotificationSettingsResponse.
+ :type: BuScheduleNotificationsSettingsResponse
+ """
+
+
+ self._scheduling = scheduling
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/bu_schedule_notifications_category_settings.py b/build/PureCloudPlatformClientV2/models/bu_schedule_notifications_category_settings.py
new file mode 100644
index 000000000..47db5bca8
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/bu_schedule_notifications_category_settings.py
@@ -0,0 +1,198 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+
+class BuScheduleNotificationsCategorySettings(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ BuScheduleNotificationsCategorySettings - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'activity_category': 'str',
+ 'early_reminder_enabled': 'bool',
+ 'on_time_reminder_enabled': 'bool'
+ }
+
+ self.attribute_map = {
+ 'activity_category': 'activityCategory',
+ 'early_reminder_enabled': 'earlyReminderEnabled',
+ 'on_time_reminder_enabled': 'onTimeReminderEnabled'
+ }
+
+ self._activity_category = None
+ self._early_reminder_enabled = None
+ self._on_time_reminder_enabled = None
+
+ @property
+ def activity_category(self) -> str:
+ """
+ Gets the activity_category of this BuScheduleNotificationsCategorySettings.
+ The activity category
+
+ :return: The activity_category of this BuScheduleNotificationsCategorySettings.
+ :rtype: str
+ """
+ return self._activity_category
+
+ @activity_category.setter
+ def activity_category(self, activity_category: str) -> None:
+ """
+ Sets the activity_category of this BuScheduleNotificationsCategorySettings.
+ The activity category
+
+ :param activity_category: The activity_category of this BuScheduleNotificationsCategorySettings.
+ :type: str
+ """
+ if isinstance(activity_category, int):
+ activity_category = str(activity_category)
+ allowed_values = ["OnQueueWork", "Break", "Meal", "Meeting", "OffQueueWork", "TimeOff", "Training", "Unavailable", "Unscheduled"]
+ if activity_category.lower() not in map(str.lower, allowed_values):
+ # print("Invalid value for activity_category -> " + activity_category)
+ self._activity_category = "outdated_sdk_version"
+ else:
+ self._activity_category = activity_category
+
+ @property
+ def early_reminder_enabled(self) -> bool:
+ """
+ Gets the early_reminder_enabled of this BuScheduleNotificationsCategorySettings.
+ Indicates if agents should receive early schedule reminder notifications.
+
+ :return: The early_reminder_enabled of this BuScheduleNotificationsCategorySettings.
+ :rtype: bool
+ """
+ return self._early_reminder_enabled
+
+ @early_reminder_enabled.setter
+ def early_reminder_enabled(self, early_reminder_enabled: bool) -> None:
+ """
+ Sets the early_reminder_enabled of this BuScheduleNotificationsCategorySettings.
+ Indicates if agents should receive early schedule reminder notifications.
+
+ :param early_reminder_enabled: The early_reminder_enabled of this BuScheduleNotificationsCategorySettings.
+ :type: bool
+ """
+
+
+ self._early_reminder_enabled = early_reminder_enabled
+
+ @property
+ def on_time_reminder_enabled(self) -> bool:
+ """
+ Gets the on_time_reminder_enabled of this BuScheduleNotificationsCategorySettings.
+ Indicates if agents should receive out of adherence notifications.
+
+ :return: The on_time_reminder_enabled of this BuScheduleNotificationsCategorySettings.
+ :rtype: bool
+ """
+ return self._on_time_reminder_enabled
+
+ @on_time_reminder_enabled.setter
+ def on_time_reminder_enabled(self, on_time_reminder_enabled: bool) -> None:
+ """
+ Sets the on_time_reminder_enabled of this BuScheduleNotificationsCategorySettings.
+ Indicates if agents should receive out of adherence notifications.
+
+ :param on_time_reminder_enabled: The on_time_reminder_enabled of this BuScheduleNotificationsCategorySettings.
+ :type: bool
+ """
+
+
+ self._on_time_reminder_enabled = on_time_reminder_enabled
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/bu_schedule_notifications_settings_request.py b/build/PureCloudPlatformClientV2/models/bu_schedule_notifications_settings_request.py
new file mode 100644
index 000000000..b5a11f310
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/bu_schedule_notifications_settings_request.py
@@ -0,0 +1,168 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import BuScheduleNotificationsCategorySettings
+
+class BuScheduleNotificationsSettingsRequest(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ BuScheduleNotificationsSettingsRequest - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'early_reminder_minutes': 'int',
+ 'activity_category_settings': 'list[BuScheduleNotificationsCategorySettings]'
+ }
+
+ self.attribute_map = {
+ 'early_reminder_minutes': 'earlyReminderMinutes',
+ 'activity_category_settings': 'activityCategorySettings'
+ }
+
+ self._early_reminder_minutes = None
+ self._activity_category_settings = None
+
+ @property
+ def early_reminder_minutes(self) -> int:
+ """
+ Gets the early_reminder_minutes of this BuScheduleNotificationsSettingsRequest.
+ The number of minutes prior to the scheduled event to display an early reminder notification
+
+ :return: The early_reminder_minutes of this BuScheduleNotificationsSettingsRequest.
+ :rtype: int
+ """
+ return self._early_reminder_minutes
+
+ @early_reminder_minutes.setter
+ def early_reminder_minutes(self, early_reminder_minutes: int) -> None:
+ """
+ Sets the early_reminder_minutes of this BuScheduleNotificationsSettingsRequest.
+ The number of minutes prior to the scheduled event to display an early reminder notification
+
+ :param early_reminder_minutes: The early_reminder_minutes of this BuScheduleNotificationsSettingsRequest.
+ :type: int
+ """
+
+
+ self._early_reminder_minutes = early_reminder_minutes
+
+ @property
+ def activity_category_settings(self) -> List['BuScheduleNotificationsCategorySettings']:
+ """
+ Gets the activity_category_settings of this BuScheduleNotificationsSettingsRequest.
+ List of activity category notification settings
+
+ :return: The activity_category_settings of this BuScheduleNotificationsSettingsRequest.
+ :rtype: list[BuScheduleNotificationsCategorySettings]
+ """
+ return self._activity_category_settings
+
+ @activity_category_settings.setter
+ def activity_category_settings(self, activity_category_settings: List['BuScheduleNotificationsCategorySettings']) -> None:
+ """
+ Sets the activity_category_settings of this BuScheduleNotificationsSettingsRequest.
+ List of activity category notification settings
+
+ :param activity_category_settings: The activity_category_settings of this BuScheduleNotificationsSettingsRequest.
+ :type: list[BuScheduleNotificationsCategorySettings]
+ """
+
+
+ self._activity_category_settings = activity_category_settings
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/bu_schedule_notifications_settings_response.py b/build/PureCloudPlatformClientV2/models/bu_schedule_notifications_settings_response.py
new file mode 100644
index 000000000..0da913116
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/bu_schedule_notifications_settings_response.py
@@ -0,0 +1,168 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import BuScheduleNotificationsCategorySettings
+
+class BuScheduleNotificationsSettingsResponse(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ BuScheduleNotificationsSettingsResponse - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'early_reminder_minutes': 'int',
+ 'activity_category_settings': 'list[BuScheduleNotificationsCategorySettings]'
+ }
+
+ self.attribute_map = {
+ 'early_reminder_minutes': 'earlyReminderMinutes',
+ 'activity_category_settings': 'activityCategorySettings'
+ }
+
+ self._early_reminder_minutes = None
+ self._activity_category_settings = None
+
+ @property
+ def early_reminder_minutes(self) -> int:
+ """
+ Gets the early_reminder_minutes of this BuScheduleNotificationsSettingsResponse.
+ The number of minutes prior to the scheduled event to display an early reminder notification
+
+ :return: The early_reminder_minutes of this BuScheduleNotificationsSettingsResponse.
+ :rtype: int
+ """
+ return self._early_reminder_minutes
+
+ @early_reminder_minutes.setter
+ def early_reminder_minutes(self, early_reminder_minutes: int) -> None:
+ """
+ Sets the early_reminder_minutes of this BuScheduleNotificationsSettingsResponse.
+ The number of minutes prior to the scheduled event to display an early reminder notification
+
+ :param early_reminder_minutes: The early_reminder_minutes of this BuScheduleNotificationsSettingsResponse.
+ :type: int
+ """
+
+
+ self._early_reminder_minutes = early_reminder_minutes
+
+ @property
+ def activity_category_settings(self) -> List['BuScheduleNotificationsCategorySettings']:
+ """
+ Gets the activity_category_settings of this BuScheduleNotificationsSettingsResponse.
+ List of activity category notification settings
+
+ :return: The activity_category_settings of this BuScheduleNotificationsSettingsResponse.
+ :rtype: list[BuScheduleNotificationsCategorySettings]
+ """
+ return self._activity_category_settings
+
+ @activity_category_settings.setter
+ def activity_category_settings(self, activity_category_settings: List['BuScheduleNotificationsCategorySettings']) -> None:
+ """
+ Sets the activity_category_settings of this BuScheduleNotificationsSettingsResponse.
+ List of activity category notification settings
+
+ :param activity_category_settings: The activity_category_settings of this BuScheduleNotificationsSettingsResponse.
+ :type: list[BuScheduleNotificationsCategorySettings]
+ """
+
+
+ self._activity_category_settings = activity_category_settings
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/cached_media_item_entity_listing.py b/build/PureCloudPlatformClientV2/models/cached_media_item_entity_listing.py
index 93c2ba0a4..eb4728425 100644
--- a/build/PureCloudPlatformClientV2/models/cached_media_item_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/cached_media_item_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CachedMediaItemEntityListing.
+ Gets the first_uri of this CachedMediaItemEntityListing.
- :return: The last_uri of this CachedMediaItemEntityListing.
+ :return: The first_uri of this CachedMediaItemEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CachedMediaItemEntityListing.
+ Sets the first_uri of this CachedMediaItemEntityListing.
- :param last_uri: The last_uri of this CachedMediaItemEntityListing.
+ :param first_uri: The first_uri of this CachedMediaItemEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CachedMediaItemEntityListing.
+ Gets the last_uri of this CachedMediaItemEntityListing.
- :return: The first_uri of this CachedMediaItemEntityListing.
+ :return: The last_uri of this CachedMediaItemEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CachedMediaItemEntityListing.
+ Sets the last_uri of this CachedMediaItemEntityListing.
- :param first_uri: The first_uri of this CachedMediaItemEntityListing.
+ :param last_uri: The last_uri of this CachedMediaItemEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/calibration_entity_listing.py b/build/PureCloudPlatformClientV2/models/calibration_entity_listing.py
index 53928da43..52e65d355 100644
--- a/build/PureCloudPlatformClientV2/models/calibration_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/calibration_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CalibrationEntityListing.
+ Gets the first_uri of this CalibrationEntityListing.
- :return: The last_uri of this CalibrationEntityListing.
+ :return: The first_uri of this CalibrationEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CalibrationEntityListing.
+ Sets the first_uri of this CalibrationEntityListing.
- :param last_uri: The last_uri of this CalibrationEntityListing.
+ :param first_uri: The first_uri of this CalibrationEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CalibrationEntityListing.
+ Gets the last_uri of this CalibrationEntityListing.
- :return: The first_uri of this CalibrationEntityListing.
+ :return: The last_uri of this CalibrationEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CalibrationEntityListing.
+ Sets the last_uri of this CalibrationEntityListing.
- :param first_uri: The first_uri of this CalibrationEntityListing.
+ :param last_uri: The last_uri of this CalibrationEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/call_conversation_entity_listing.py b/build/PureCloudPlatformClientV2/models/call_conversation_entity_listing.py
index 2fa43f083..b88699220 100644
--- a/build/PureCloudPlatformClientV2/models/call_conversation_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/call_conversation_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CallConversationEntityListing.
+ Gets the first_uri of this CallConversationEntityListing.
- :return: The last_uri of this CallConversationEntityListing.
+ :return: The first_uri of this CallConversationEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CallConversationEntityListing.
+ Sets the first_uri of this CallConversationEntityListing.
- :param last_uri: The last_uri of this CallConversationEntityListing.
+ :param first_uri: The first_uri of this CallConversationEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CallConversationEntityListing.
+ Gets the last_uri of this CallConversationEntityListing.
- :return: The first_uri of this CallConversationEntityListing.
+ :return: The last_uri of this CallConversationEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CallConversationEntityListing.
+ Sets the last_uri of this CallConversationEntityListing.
- :param first_uri: The first_uri of this CallConversationEntityListing.
+ :param last_uri: The last_uri of this CallConversationEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/call_history_conversation_entity_listing.py b/build/PureCloudPlatformClientV2/models/call_history_conversation_entity_listing.py
index 3db9a9a73..c394af240 100644
--- a/build/PureCloudPlatformClientV2/models/call_history_conversation_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/call_history_conversation_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CallHistoryConversationEntityListing.
+ Gets the first_uri of this CallHistoryConversationEntityListing.
- :return: The last_uri of this CallHistoryConversationEntityListing.
+ :return: The first_uri of this CallHistoryConversationEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CallHistoryConversationEntityListing.
+ Sets the first_uri of this CallHistoryConversationEntityListing.
- :param last_uri: The last_uri of this CallHistoryConversationEntityListing.
+ :param first_uri: The first_uri of this CallHistoryConversationEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CallHistoryConversationEntityListing.
+ Gets the last_uri of this CallHistoryConversationEntityListing.
- :return: The first_uri of this CallHistoryConversationEntityListing.
+ :return: The last_uri of this CallHistoryConversationEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CallHistoryConversationEntityListing.
+ Sets the last_uri of this CallHistoryConversationEntityListing.
- :param first_uri: The first_uri of this CallHistoryConversationEntityListing.
+ :param last_uri: The last_uri of this CallHistoryConversationEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/callable_time_set_entity_listing.py b/build/PureCloudPlatformClientV2/models/callable_time_set_entity_listing.py
index b51a5c0c1..7b83d18f5 100644
--- a/build/PureCloudPlatformClientV2/models/callable_time_set_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/callable_time_set_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CallableTimeSetEntityListing.
+ Gets the first_uri of this CallableTimeSetEntityListing.
- :return: The last_uri of this CallableTimeSetEntityListing.
+ :return: The first_uri of this CallableTimeSetEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CallableTimeSetEntityListing.
+ Sets the first_uri of this CallableTimeSetEntityListing.
- :param last_uri: The last_uri of this CallableTimeSetEntityListing.
+ :param first_uri: The first_uri of this CallableTimeSetEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CallableTimeSetEntityListing.
+ Gets the last_uri of this CallableTimeSetEntityListing.
- :return: The first_uri of this CallableTimeSetEntityListing.
+ :return: The last_uri of this CallableTimeSetEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CallableTimeSetEntityListing.
+ Sets the last_uri of this CallableTimeSetEntityListing.
- :param first_uri: The first_uri of this CallableTimeSetEntityListing.
+ :param last_uri: The last_uri of this CallableTimeSetEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/callback_conversation_entity_listing.py b/build/PureCloudPlatformClientV2/models/callback_conversation_entity_listing.py
index 3f0717c9f..40ec0141e 100644
--- a/build/PureCloudPlatformClientV2/models/callback_conversation_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/callback_conversation_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CallbackConversationEntityListing.
+ Gets the first_uri of this CallbackConversationEntityListing.
- :return: The last_uri of this CallbackConversationEntityListing.
+ :return: The first_uri of this CallbackConversationEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CallbackConversationEntityListing.
+ Sets the first_uri of this CallbackConversationEntityListing.
- :param last_uri: The last_uri of this CallbackConversationEntityListing.
+ :param first_uri: The first_uri of this CallbackConversationEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CallbackConversationEntityListing.
+ Gets the last_uri of this CallbackConversationEntityListing.
- :return: The first_uri of this CallbackConversationEntityListing.
+ :return: The last_uri of this CallbackConversationEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CallbackConversationEntityListing.
+ Sets the last_uri of this CallbackConversationEntityListing.
- :param first_uri: The first_uri of this CallbackConversationEntityListing.
+ :param last_uri: The last_uri of this CallbackConversationEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/campaign_division_view_listing.py b/build/PureCloudPlatformClientV2/models/campaign_division_view_listing.py
index 76510d11c..2ec78d3c3 100644
--- a/build/PureCloudPlatformClientV2/models/campaign_division_view_listing.py
+++ b/build/PureCloudPlatformClientV2/models/campaign_division_view_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CampaignDivisionViewListing.
+ Gets the first_uri of this CampaignDivisionViewListing.
- :return: The last_uri of this CampaignDivisionViewListing.
+ :return: The first_uri of this CampaignDivisionViewListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CampaignDivisionViewListing.
+ Sets the first_uri of this CampaignDivisionViewListing.
- :param last_uri: The last_uri of this CampaignDivisionViewListing.
+ :param first_uri: The first_uri of this CampaignDivisionViewListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CampaignDivisionViewListing.
+ Gets the last_uri of this CampaignDivisionViewListing.
- :return: The first_uri of this CampaignDivisionViewListing.
+ :return: The last_uri of this CampaignDivisionViewListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CampaignDivisionViewListing.
+ Sets the last_uri of this CampaignDivisionViewListing.
- :param first_uri: The first_uri of this CampaignDivisionViewListing.
+ :param last_uri: The last_uri of this CampaignDivisionViewListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/campaign_entity_listing.py b/build/PureCloudPlatformClientV2/models/campaign_entity_listing.py
index 854a7cc03..81e805454 100644
--- a/build/PureCloudPlatformClientV2/models/campaign_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/campaign_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CampaignEntityListing.
+ Gets the first_uri of this CampaignEntityListing.
- :return: The last_uri of this CampaignEntityListing.
+ :return: The first_uri of this CampaignEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CampaignEntityListing.
+ Sets the first_uri of this CampaignEntityListing.
- :param last_uri: The last_uri of this CampaignEntityListing.
+ :param first_uri: The first_uri of this CampaignEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CampaignEntityListing.
+ Gets the last_uri of this CampaignEntityListing.
- :return: The first_uri of this CampaignEntityListing.
+ :return: The last_uri of this CampaignEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CampaignEntityListing.
+ Sets the last_uri of this CampaignEntityListing.
- :param first_uri: The first_uri of this CampaignEntityListing.
+ :param last_uri: The last_uri of this CampaignEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/campaign_rule_condition_group.py b/build/PureCloudPlatformClientV2/models/campaign_rule_condition_group.py
new file mode 100644
index 000000000..b88d4b012
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/campaign_rule_condition_group.py
@@ -0,0 +1,168 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import CampaignRuleCondition
+
+class CampaignRuleConditionGroup(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ CampaignRuleConditionGroup - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'match_any_conditions': 'bool',
+ 'conditions': 'list[CampaignRuleCondition]'
+ }
+
+ self.attribute_map = {
+ 'match_any_conditions': 'matchAnyConditions',
+ 'conditions': 'conditions'
+ }
+
+ self._match_any_conditions = None
+ self._conditions = None
+
+ @property
+ def match_any_conditions(self) -> bool:
+ """
+ Gets the match_any_conditions of this CampaignRuleConditionGroup.
+ Whether or not this condition group should be evaluated as true if any of sub conditions is matched
+
+ :return: The match_any_conditions of this CampaignRuleConditionGroup.
+ :rtype: bool
+ """
+ return self._match_any_conditions
+
+ @match_any_conditions.setter
+ def match_any_conditions(self, match_any_conditions: bool) -> None:
+ """
+ Sets the match_any_conditions of this CampaignRuleConditionGroup.
+ Whether or not this condition group should be evaluated as true if any of sub conditions is matched
+
+ :param match_any_conditions: The match_any_conditions of this CampaignRuleConditionGroup.
+ :type: bool
+ """
+
+
+ self._match_any_conditions = match_any_conditions
+
+ @property
+ def conditions(self) -> List['CampaignRuleCondition']:
+ """
+ Gets the conditions of this CampaignRuleConditionGroup.
+ The parameters for the CampaignRuleCondition.
+
+ :return: The conditions of this CampaignRuleConditionGroup.
+ :rtype: list[CampaignRuleCondition]
+ """
+ return self._conditions
+
+ @conditions.setter
+ def conditions(self, conditions: List['CampaignRuleCondition']) -> None:
+ """
+ Sets the conditions of this CampaignRuleConditionGroup.
+ The parameters for the CampaignRuleCondition.
+
+ :param conditions: The conditions of this CampaignRuleConditionGroup.
+ :type: list[CampaignRuleCondition]
+ """
+
+
+ self._conditions = conditions
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/campaign_rule_entity_listing.py b/build/PureCloudPlatformClientV2/models/campaign_rule_entity_listing.py
index ff65da3a8..27776c1e6 100644
--- a/build/PureCloudPlatformClientV2/models/campaign_rule_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/campaign_rule_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CampaignRuleEntityListing.
+ Gets the first_uri of this CampaignRuleEntityListing.
- :return: The last_uri of this CampaignRuleEntityListing.
+ :return: The first_uri of this CampaignRuleEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CampaignRuleEntityListing.
+ Sets the first_uri of this CampaignRuleEntityListing.
- :param last_uri: The last_uri of this CampaignRuleEntityListing.
+ :param first_uri: The first_uri of this CampaignRuleEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CampaignRuleEntityListing.
+ Gets the last_uri of this CampaignRuleEntityListing.
- :return: The first_uri of this CampaignRuleEntityListing.
+ :return: The last_uri of this CampaignRuleEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CampaignRuleEntityListing.
+ Sets the last_uri of this CampaignRuleEntityListing.
- :param first_uri: The first_uri of this CampaignRuleEntityListing.
+ :param last_uri: The last_uri of this CampaignRuleEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/campaign_sequence_entity_listing.py b/build/PureCloudPlatformClientV2/models/campaign_sequence_entity_listing.py
index d6949dff3..f856e6af0 100644
--- a/build/PureCloudPlatformClientV2/models/campaign_sequence_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/campaign_sequence_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CampaignSequenceEntityListing.
+ Gets the first_uri of this CampaignSequenceEntityListing.
- :return: The last_uri of this CampaignSequenceEntityListing.
+ :return: The first_uri of this CampaignSequenceEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CampaignSequenceEntityListing.
+ Sets the first_uri of this CampaignSequenceEntityListing.
- :param last_uri: The last_uri of this CampaignSequenceEntityListing.
+ :param first_uri: The first_uri of this CampaignSequenceEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CampaignSequenceEntityListing.
+ Gets the last_uri of this CampaignSequenceEntityListing.
- :return: The first_uri of this CampaignSequenceEntityListing.
+ :return: The last_uri of this CampaignSequenceEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CampaignSequenceEntityListing.
+ Sets the last_uri of this CampaignSequenceEntityListing.
- :param first_uri: The first_uri of this CampaignSequenceEntityListing.
+ :param last_uri: The last_uri of this CampaignSequenceEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/categories_entity_listing.py b/build/PureCloudPlatformClientV2/models/categories_entity_listing.py
index 2a4ca8dbc..15177fac6 100644
--- a/build/PureCloudPlatformClientV2/models/categories_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/categories_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CategoriesEntityListing.
+ Gets the first_uri of this CategoriesEntityListing.
- :return: The last_uri of this CategoriesEntityListing.
+ :return: The first_uri of this CategoriesEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CategoriesEntityListing.
+ Sets the first_uri of this CategoriesEntityListing.
- :param last_uri: The last_uri of this CategoriesEntityListing.
+ :param first_uri: The first_uri of this CategoriesEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CategoriesEntityListing.
+ Gets the last_uri of this CategoriesEntityListing.
- :return: The first_uri of this CategoriesEntityListing.
+ :return: The last_uri of this CategoriesEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CategoriesEntityListing.
+ Sets the last_uri of this CategoriesEntityListing.
- :param first_uri: The first_uri of this CategoriesEntityListing.
+ :param last_uri: The last_uri of this CategoriesEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/certificate_authority_entity_listing.py b/build/PureCloudPlatformClientV2/models/certificate_authority_entity_listing.py
index 16832375d..7fb2564d8 100644
--- a/build/PureCloudPlatformClientV2/models/certificate_authority_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/certificate_authority_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CertificateAuthorityEntityListing.
+ Gets the first_uri of this CertificateAuthorityEntityListing.
- :return: The last_uri of this CertificateAuthorityEntityListing.
+ :return: The first_uri of this CertificateAuthorityEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CertificateAuthorityEntityListing.
+ Sets the first_uri of this CertificateAuthorityEntityListing.
- :param last_uri: The last_uri of this CertificateAuthorityEntityListing.
+ :param first_uri: The first_uri of this CertificateAuthorityEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CertificateAuthorityEntityListing.
+ Gets the last_uri of this CertificateAuthorityEntityListing.
- :return: The first_uri of this CertificateAuthorityEntityListing.
+ :return: The last_uri of this CertificateAuthorityEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CertificateAuthorityEntityListing.
+ Sets the last_uri of this CertificateAuthorityEntityListing.
- :param first_uri: The first_uri of this CertificateAuthorityEntityListing.
+ :param last_uri: The last_uri of this CertificateAuthorityEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/chat_conversation_entity_listing.py b/build/PureCloudPlatformClientV2/models/chat_conversation_entity_listing.py
index 1aef252de..dd69f305b 100644
--- a/build/PureCloudPlatformClientV2/models/chat_conversation_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/chat_conversation_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ChatConversationEntityListing.
+ Gets the first_uri of this ChatConversationEntityListing.
- :return: The last_uri of this ChatConversationEntityListing.
+ :return: The first_uri of this ChatConversationEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ChatConversationEntityListing.
+ Sets the first_uri of this ChatConversationEntityListing.
- :param last_uri: The last_uri of this ChatConversationEntityListing.
+ :param first_uri: The first_uri of this ChatConversationEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ChatConversationEntityListing.
+ Gets the last_uri of this ChatConversationEntityListing.
- :return: The first_uri of this ChatConversationEntityListing.
+ :return: The last_uri of this ChatConversationEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ChatConversationEntityListing.
+ Sets the last_uri of this ChatConversationEntityListing.
- :param first_uri: The first_uri of this ChatConversationEntityListing.
+ :param last_uri: The last_uri of this ChatConversationEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/client_app_entity_listing.py b/build/PureCloudPlatformClientV2/models/client_app_entity_listing.py
index ef692ac7b..0c5176cb8 100644
--- a/build/PureCloudPlatformClientV2/models/client_app_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/client_app_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ClientAppEntityListing.
+ Gets the first_uri of this ClientAppEntityListing.
- :return: The last_uri of this ClientAppEntityListing.
+ :return: The first_uri of this ClientAppEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ClientAppEntityListing.
+ Sets the first_uri of this ClientAppEntityListing.
- :param last_uri: The last_uri of this ClientAppEntityListing.
+ :param first_uri: The first_uri of this ClientAppEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ClientAppEntityListing.
+ Gets the last_uri of this ClientAppEntityListing.
- :return: The first_uri of this ClientAppEntityListing.
+ :return: The last_uri of this ClientAppEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ClientAppEntityListing.
+ Sets the last_uri of this ClientAppEntityListing.
- :param first_uri: The first_uri of this ClientAppEntityListing.
+ :param last_uri: The last_uri of this ClientAppEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/coaching_annotation_list.py b/build/PureCloudPlatformClientV2/models/coaching_annotation_list.py
index 1b0b386f6..63e1605f5 100644
--- a/build/PureCloudPlatformClientV2/models/coaching_annotation_list.py
+++ b/build/PureCloudPlatformClientV2/models/coaching_annotation_list.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CoachingAnnotationList.
+ Gets the first_uri of this CoachingAnnotationList.
- :return: The last_uri of this CoachingAnnotationList.
+ :return: The first_uri of this CoachingAnnotationList.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CoachingAnnotationList.
+ Sets the first_uri of this CoachingAnnotationList.
- :param last_uri: The last_uri of this CoachingAnnotationList.
+ :param first_uri: The first_uri of this CoachingAnnotationList.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CoachingAnnotationList.
+ Gets the last_uri of this CoachingAnnotationList.
- :return: The first_uri of this CoachingAnnotationList.
+ :return: The last_uri of this CoachingAnnotationList.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CoachingAnnotationList.
+ Sets the last_uri of this CoachingAnnotationList.
- :param first_uri: The first_uri of this CoachingAnnotationList.
+ :param last_uri: The last_uri of this CoachingAnnotationList.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/coaching_appointment_response_list.py b/build/PureCloudPlatformClientV2/models/coaching_appointment_response_list.py
index eb2d7370f..945397c74 100644
--- a/build/PureCloudPlatformClientV2/models/coaching_appointment_response_list.py
+++ b/build/PureCloudPlatformClientV2/models/coaching_appointment_response_list.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CoachingAppointmentResponseList.
+ Gets the first_uri of this CoachingAppointmentResponseList.
- :return: The last_uri of this CoachingAppointmentResponseList.
+ :return: The first_uri of this CoachingAppointmentResponseList.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CoachingAppointmentResponseList.
+ Sets the first_uri of this CoachingAppointmentResponseList.
- :param last_uri: The last_uri of this CoachingAppointmentResponseList.
+ :param first_uri: The first_uri of this CoachingAppointmentResponseList.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CoachingAppointmentResponseList.
+ Gets the last_uri of this CoachingAppointmentResponseList.
- :return: The first_uri of this CoachingAppointmentResponseList.
+ :return: The last_uri of this CoachingAppointmentResponseList.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CoachingAppointmentResponseList.
+ Sets the last_uri of this CoachingAppointmentResponseList.
- :param first_uri: The first_uri of this CoachingAppointmentResponseList.
+ :param last_uri: The last_uri of this CoachingAppointmentResponseList.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/coaching_notification_list.py b/build/PureCloudPlatformClientV2/models/coaching_notification_list.py
index deccc32b6..7dc82b454 100644
--- a/build/PureCloudPlatformClientV2/models/coaching_notification_list.py
+++ b/build/PureCloudPlatformClientV2/models/coaching_notification_list.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CoachingNotificationList.
+ Gets the first_uri of this CoachingNotificationList.
- :return: The last_uri of this CoachingNotificationList.
+ :return: The first_uri of this CoachingNotificationList.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CoachingNotificationList.
+ Sets the first_uri of this CoachingNotificationList.
- :param last_uri: The last_uri of this CoachingNotificationList.
+ :param first_uri: The first_uri of this CoachingNotificationList.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CoachingNotificationList.
+ Gets the last_uri of this CoachingNotificationList.
- :return: The first_uri of this CoachingNotificationList.
+ :return: The last_uri of this CoachingNotificationList.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CoachingNotificationList.
+ Sets the last_uri of this CoachingNotificationList.
- :param first_uri: The first_uri of this CoachingNotificationList.
+ :param last_uri: The last_uri of this CoachingNotificationList.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/cobrowse_conversation_entity_listing.py b/build/PureCloudPlatformClientV2/models/cobrowse_conversation_entity_listing.py
index 382762f24..6291ba94d 100644
--- a/build/PureCloudPlatformClientV2/models/cobrowse_conversation_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/cobrowse_conversation_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CobrowseConversationEntityListing.
+ Gets the first_uri of this CobrowseConversationEntityListing.
- :return: The last_uri of this CobrowseConversationEntityListing.
+ :return: The first_uri of this CobrowseConversationEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CobrowseConversationEntityListing.
+ Sets the first_uri of this CobrowseConversationEntityListing.
- :param last_uri: The last_uri of this CobrowseConversationEntityListing.
+ :param first_uri: The first_uri of this CobrowseConversationEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CobrowseConversationEntityListing.
+ Gets the last_uri of this CobrowseConversationEntityListing.
- :return: The first_uri of this CobrowseConversationEntityListing.
+ :return: The last_uri of this CobrowseConversationEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CobrowseConversationEntityListing.
+ Sets the last_uri of this CobrowseConversationEntityListing.
- :param first_uri: The first_uri of this CobrowseConversationEntityListing.
+ :param last_uri: The last_uri of this CobrowseConversationEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/command_status_entity_listing.py b/build/PureCloudPlatformClientV2/models/command_status_entity_listing.py
index 0335f7b5d..113581bba 100644
--- a/build/PureCloudPlatformClientV2/models/command_status_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/command_status_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CommandStatusEntityListing.
+ Gets the first_uri of this CommandStatusEntityListing.
- :return: The last_uri of this CommandStatusEntityListing.
+ :return: The first_uri of this CommandStatusEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CommandStatusEntityListing.
+ Sets the first_uri of this CommandStatusEntityListing.
- :param last_uri: The last_uri of this CommandStatusEntityListing.
+ :param first_uri: The first_uri of this CommandStatusEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CommandStatusEntityListing.
+ Gets the last_uri of this CommandStatusEntityListing.
- :return: The first_uri of this CommandStatusEntityListing.
+ :return: The last_uri of this CommandStatusEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CommandStatusEntityListing.
+ Sets the last_uri of this CommandStatusEntityListing.
- :param first_uri: The first_uri of this CommandStatusEntityListing.
+ :param last_uri: The last_uri of this CommandStatusEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/common_campaign_division_view_entity_listing.py b/build/PureCloudPlatformClientV2/models/common_campaign_division_view_entity_listing.py
index d87282e2f..338c1a4dd 100644
--- a/build/PureCloudPlatformClientV2/models/common_campaign_division_view_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/common_campaign_division_view_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CommonCampaignDivisionViewEntityListing.
+ Gets the first_uri of this CommonCampaignDivisionViewEntityListing.
- :return: The last_uri of this CommonCampaignDivisionViewEntityListing.
+ :return: The first_uri of this CommonCampaignDivisionViewEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CommonCampaignDivisionViewEntityListing.
+ Sets the first_uri of this CommonCampaignDivisionViewEntityListing.
- :param last_uri: The last_uri of this CommonCampaignDivisionViewEntityListing.
+ :param first_uri: The first_uri of this CommonCampaignDivisionViewEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CommonCampaignDivisionViewEntityListing.
+ Gets the last_uri of this CommonCampaignDivisionViewEntityListing.
- :return: The first_uri of this CommonCampaignDivisionViewEntityListing.
+ :return: The last_uri of this CommonCampaignDivisionViewEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CommonCampaignDivisionViewEntityListing.
+ Sets the last_uri of this CommonCampaignDivisionViewEntityListing.
- :param first_uri: The first_uri of this CommonCampaignDivisionViewEntityListing.
+ :param last_uri: The last_uri of this CommonCampaignDivisionViewEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/common_campaign_entity_listing.py b/build/PureCloudPlatformClientV2/models/common_campaign_entity_listing.py
index 147d6f576..839e427ad 100644
--- a/build/PureCloudPlatformClientV2/models/common_campaign_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/common_campaign_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CommonCampaignEntityListing.
+ Gets the first_uri of this CommonCampaignEntityListing.
- :return: The last_uri of this CommonCampaignEntityListing.
+ :return: The first_uri of this CommonCampaignEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CommonCampaignEntityListing.
+ Sets the first_uri of this CommonCampaignEntityListing.
- :param last_uri: The last_uri of this CommonCampaignEntityListing.
+ :param first_uri: The first_uri of this CommonCampaignEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CommonCampaignEntityListing.
+ Gets the last_uri of this CommonCampaignEntityListing.
- :return: The first_uri of this CommonCampaignEntityListing.
+ :return: The last_uri of this CommonCampaignEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CommonCampaignEntityListing.
+ Sets the last_uri of this CommonCampaignEntityListing.
- :param first_uri: The first_uri of this CommonCampaignEntityListing.
+ :param last_uri: The last_uri of this CommonCampaignEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/common_rule_container.py b/build/PureCloudPlatformClientV2/models/common_rule_container.py
index 525168904..f3e9182c8 100644
--- a/build/PureCloudPlatformClientV2/models/common_rule_container.py
+++ b/build/PureCloudPlatformClientV2/models/common_rule_container.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CommonRuleContainer.
+ Gets the first_uri of this CommonRuleContainer.
- :return: The last_uri of this CommonRuleContainer.
+ :return: The first_uri of this CommonRuleContainer.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CommonRuleContainer.
+ Sets the first_uri of this CommonRuleContainer.
- :param last_uri: The last_uri of this CommonRuleContainer.
+ :param first_uri: The first_uri of this CommonRuleContainer.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CommonRuleContainer.
+ Gets the last_uri of this CommonRuleContainer.
- :return: The first_uri of this CommonRuleContainer.
+ :return: The last_uri of this CommonRuleContainer.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CommonRuleContainer.
+ Sets the last_uri of this CommonRuleContainer.
- :param first_uri: The first_uri of this CommonRuleContainer.
+ :param last_uri: The last_uri of this CommonRuleContainer.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/consumed_resources_entity_listing.py b/build/PureCloudPlatformClientV2/models/consumed_resources_entity_listing.py
index 70cb32e68..27bd24fd2 100644
--- a/build/PureCloudPlatformClientV2/models/consumed_resources_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/consumed_resources_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ConsumedResourcesEntityListing.
+ Gets the first_uri of this ConsumedResourcesEntityListing.
- :return: The last_uri of this ConsumedResourcesEntityListing.
+ :return: The first_uri of this ConsumedResourcesEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ConsumedResourcesEntityListing.
+ Sets the first_uri of this ConsumedResourcesEntityListing.
- :param last_uri: The last_uri of this ConsumedResourcesEntityListing.
+ :param first_uri: The first_uri of this ConsumedResourcesEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ConsumedResourcesEntityListing.
+ Gets the last_uri of this ConsumedResourcesEntityListing.
- :return: The first_uri of this ConsumedResourcesEntityListing.
+ :return: The last_uri of this ConsumedResourcesEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ConsumedResourcesEntityListing.
+ Sets the last_uri of this ConsumedResourcesEntityListing.
- :param first_uri: The first_uri of this ConsumedResourcesEntityListing.
+ :param last_uri: The last_uri of this ConsumedResourcesEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/consuming_resources_entity_listing.py b/build/PureCloudPlatformClientV2/models/consuming_resources_entity_listing.py
index 585fb4b8d..2e08906ce 100644
--- a/build/PureCloudPlatformClientV2/models/consuming_resources_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/consuming_resources_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ConsumingResourcesEntityListing.
+ Gets the first_uri of this ConsumingResourcesEntityListing.
- :return: The last_uri of this ConsumingResourcesEntityListing.
+ :return: The first_uri of this ConsumingResourcesEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ConsumingResourcesEntityListing.
+ Sets the first_uri of this ConsumingResourcesEntityListing.
- :param last_uri: The last_uri of this ConsumingResourcesEntityListing.
+ :param first_uri: The first_uri of this ConsumingResourcesEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ConsumingResourcesEntityListing.
+ Gets the last_uri of this ConsumingResourcesEntityListing.
- :return: The first_uri of this ConsumingResourcesEntityListing.
+ :return: The last_uri of this ConsumingResourcesEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ConsumingResourcesEntityListing.
+ Sets the last_uri of this ConsumingResourcesEntityListing.
- :param first_uri: The first_uri of this ConsumingResourcesEntityListing.
+ :param last_uri: The last_uri of this ConsumingResourcesEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/contact_detail_event_topic_contact_update_event.py b/build/PureCloudPlatformClientV2/models/contact_detail_event_topic_contact_update_event.py
index b01875e0e..c4bb8659d 100644
--- a/build/PureCloudPlatformClientV2/models/contact_detail_event_topic_contact_update_event.py
+++ b/build/PureCloudPlatformClientV2/models/contact_detail_event_topic_contact_update_event.py
@@ -557,7 +557,7 @@ def message_type(self, message_type: str) -> None:
"""
if isinstance(message_type, int):
message_type = str(message_type)
- allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM"]
+ allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM", "APPLE"]
if message_type.lower() not in map(str.lower, allowed_values):
# print("Invalid value for message_type -> " + message_type)
self._message_type = "outdated_sdk_version"
diff --git a/build/PureCloudPlatformClientV2/models/contact_list_division_view_listing.py b/build/PureCloudPlatformClientV2/models/contact_list_division_view_listing.py
index 8c0f0111a..60e8d0bb8 100644
--- a/build/PureCloudPlatformClientV2/models/contact_list_division_view_listing.py
+++ b/build/PureCloudPlatformClientV2/models/contact_list_division_view_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ContactListDivisionViewListing.
+ Gets the first_uri of this ContactListDivisionViewListing.
- :return: The last_uri of this ContactListDivisionViewListing.
+ :return: The first_uri of this ContactListDivisionViewListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ContactListDivisionViewListing.
+ Sets the first_uri of this ContactListDivisionViewListing.
- :param last_uri: The last_uri of this ContactListDivisionViewListing.
+ :param first_uri: The first_uri of this ContactListDivisionViewListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ContactListDivisionViewListing.
+ Gets the last_uri of this ContactListDivisionViewListing.
- :return: The first_uri of this ContactListDivisionViewListing.
+ :return: The last_uri of this ContactListDivisionViewListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ContactListDivisionViewListing.
+ Sets the last_uri of this ContactListDivisionViewListing.
- :param first_uri: The first_uri of this ContactListDivisionViewListing.
+ :param last_uri: The last_uri of this ContactListDivisionViewListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/contact_list_entity_listing.py b/build/PureCloudPlatformClientV2/models/contact_list_entity_listing.py
index 9b19db877..e5db84bd8 100644
--- a/build/PureCloudPlatformClientV2/models/contact_list_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/contact_list_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ContactListEntityListing.
+ Gets the first_uri of this ContactListEntityListing.
- :return: The last_uri of this ContactListEntityListing.
+ :return: The first_uri of this ContactListEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ContactListEntityListing.
+ Sets the first_uri of this ContactListEntityListing.
- :param last_uri: The last_uri of this ContactListEntityListing.
+ :param first_uri: The first_uri of this ContactListEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ContactListEntityListing.
+ Gets the last_uri of this ContactListEntityListing.
- :return: The first_uri of this ContactListEntityListing.
+ :return: The last_uri of this ContactListEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ContactListEntityListing.
+ Sets the last_uri of this ContactListEntityListing.
- :param first_uri: The first_uri of this ContactListEntityListing.
+ :param last_uri: The last_uri of this ContactListEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/contact_list_filter_entity_listing.py b/build/PureCloudPlatformClientV2/models/contact_list_filter_entity_listing.py
index b863535ae..cfd1b5d8d 100644
--- a/build/PureCloudPlatformClientV2/models/contact_list_filter_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/contact_list_filter_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ContactListFilterEntityListing.
+ Gets the first_uri of this ContactListFilterEntityListing.
- :return: The last_uri of this ContactListFilterEntityListing.
+ :return: The first_uri of this ContactListFilterEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ContactListFilterEntityListing.
+ Sets the first_uri of this ContactListFilterEntityListing.
- :param last_uri: The last_uri of this ContactListFilterEntityListing.
+ :param first_uri: The first_uri of this ContactListFilterEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ContactListFilterEntityListing.
+ Gets the last_uri of this ContactListFilterEntityListing.
- :return: The first_uri of this ContactListFilterEntityListing.
+ :return: The last_uri of this ContactListFilterEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ContactListFilterEntityListing.
+ Sets the last_uri of this ContactListFilterEntityListing.
- :param first_uri: The first_uri of this ContactListFilterEntityListing.
+ :param last_uri: The last_uri of this ContactListFilterEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/contact_list_template_entity_listing.py b/build/PureCloudPlatformClientV2/models/contact_list_template_entity_listing.py
index 5798661d0..a72b92ae7 100644
--- a/build/PureCloudPlatformClientV2/models/contact_list_template_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/contact_list_template_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ContactListTemplateEntityListing.
+ Gets the first_uri of this ContactListTemplateEntityListing.
- :return: The last_uri of this ContactListTemplateEntityListing.
+ :return: The first_uri of this ContactListTemplateEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ContactListTemplateEntityListing.
+ Sets the first_uri of this ContactListTemplateEntityListing.
- :param last_uri: The last_uri of this ContactListTemplateEntityListing.
+ :param first_uri: The first_uri of this ContactListTemplateEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ContactListTemplateEntityListing.
+ Gets the last_uri of this ContactListTemplateEntityListing.
- :return: The first_uri of this ContactListTemplateEntityListing.
+ :return: The last_uri of this ContactListTemplateEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ContactListTemplateEntityListing.
+ Sets the last_uri of this ContactListTemplateEntityListing.
- :param first_uri: The first_uri of this ContactListTemplateEntityListing.
+ :param last_uri: The last_uri of this ContactListTemplateEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/contact_listing_response.py b/build/PureCloudPlatformClientV2/models/contact_listing_response.py
index 300d6b738..424ba7324 100644
--- a/build/PureCloudPlatformClientV2/models/contact_listing_response.py
+++ b/build/PureCloudPlatformClientV2/models/contact_listing_response.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'contacts_count': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'contacts_count': 'contactsCount',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._contacts_count = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def contacts_count(self, contacts_count: int) -> None:
self._contacts_count = contacts_count
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ContactListingResponse.
+ Gets the first_uri of this ContactListingResponse.
- :return: The last_uri of this ContactListingResponse.
+ :return: The first_uri of this ContactListingResponse.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ContactListingResponse.
+ Sets the first_uri of this ContactListingResponse.
- :param last_uri: The last_uri of this ContactListingResponse.
+ :param first_uri: The first_uri of this ContactListingResponse.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ContactListingResponse.
+ Gets the last_uri of this ContactListingResponse.
- :return: The first_uri of this ContactListingResponse.
+ :return: The last_uri of this ContactListingResponse.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ContactListingResponse.
+ Sets the last_uri of this ContactListingResponse.
- :param first_uri: The first_uri of this ContactListingResponse.
+ :param last_uri: The last_uri of this ContactListingResponse.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/conversation_app_settings.py b/build/PureCloudPlatformClientV2/models/conversation_app_settings.py
index 6689dcae5..6bc0b318b 100644
--- a/build/PureCloudPlatformClientV2/models/conversation_app_settings.py
+++ b/build/PureCloudPlatformClientV2/models/conversation_app_settings.py
@@ -38,6 +38,7 @@
from . import ConversationDisconnectSettings
from . import Humanize
from . import Markdown
+ from . import NotificationsSettings
class ConversationAppSettings(object):
"""
@@ -61,7 +62,8 @@ def __init__(self) -> None:
'markdown': 'Markdown',
'conversation_disconnect': 'ConversationDisconnectSettings',
'conversation_clear': 'ConversationClearSettings',
- 'humanize': 'Humanize'
+ 'humanize': 'Humanize',
+ 'notifications': 'NotificationsSettings'
}
self.attribute_map = {
@@ -72,7 +74,8 @@ def __init__(self) -> None:
'markdown': 'markdown',
'conversation_disconnect': 'conversationDisconnect',
'conversation_clear': 'conversationClear',
- 'humanize': 'humanize'
+ 'humanize': 'humanize',
+ 'notifications': 'notifications'
}
self._enabled = None
@@ -83,6 +86,7 @@ def __init__(self) -> None:
self._conversation_disconnect = None
self._conversation_clear = None
self._humanize = None
+ self._notifications = None
@property
def enabled(self) -> bool:
@@ -276,6 +280,30 @@ def humanize(self, humanize: 'Humanize') -> None:
self._humanize = humanize
+ @property
+ def notifications(self) -> 'NotificationsSettings':
+ """
+ Gets the notifications of this ConversationAppSettings.
+ The notification settings for messenger apps
+
+ :return: The notifications of this ConversationAppSettings.
+ :rtype: NotificationsSettings
+ """
+ return self._notifications
+
+ @notifications.setter
+ def notifications(self, notifications: 'NotificationsSettings') -> None:
+ """
+ Sets the notifications of this ConversationAppSettings.
+ The notification settings for messenger apps
+
+ :param notifications: The notifications of this ConversationAppSettings.
+ :type: NotificationsSettings
+ """
+
+
+ self._notifications = notifications
+
def to_dict(self):
"""
Returns the model properties as a dict
diff --git a/build/PureCloudPlatformClientV2/models/conversation_categories_entity_listing.py b/build/PureCloudPlatformClientV2/models/conversation_categories_entity_listing.py
index 02b854662..80238e977 100644
--- a/build/PureCloudPlatformClientV2/models/conversation_categories_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/conversation_categories_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ConversationCategoriesEntityListing.
+ Gets the first_uri of this ConversationCategoriesEntityListing.
- :return: The last_uri of this ConversationCategoriesEntityListing.
+ :return: The first_uri of this ConversationCategoriesEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ConversationCategoriesEntityListing.
+ Sets the first_uri of this ConversationCategoriesEntityListing.
- :param last_uri: The last_uri of this ConversationCategoriesEntityListing.
+ :param first_uri: The first_uri of this ConversationCategoriesEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ConversationCategoriesEntityListing.
+ Gets the last_uri of this ConversationCategoriesEntityListing.
- :return: The first_uri of this ConversationCategoriesEntityListing.
+ :return: The last_uri of this ConversationCategoriesEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ConversationCategoriesEntityListing.
+ Sets the last_uri of this ConversationCategoriesEntityListing.
- :param first_uri: The first_uri of this ConversationCategoriesEntityListing.
+ :param last_uri: The last_uri of this ConversationCategoriesEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/conversation_entity_listing.py b/build/PureCloudPlatformClientV2/models/conversation_entity_listing.py
index 6274940cd..31efc8b89 100644
--- a/build/PureCloudPlatformClientV2/models/conversation_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/conversation_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ConversationEntityListing.
+ Gets the first_uri of this ConversationEntityListing.
- :return: The last_uri of this ConversationEntityListing.
+ :return: The first_uri of this ConversationEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ConversationEntityListing.
+ Sets the first_uri of this ConversationEntityListing.
- :param last_uri: The last_uri of this ConversationEntityListing.
+ :param first_uri: The first_uri of this ConversationEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ConversationEntityListing.
+ Gets the last_uri of this ConversationEntityListing.
- :return: The first_uri of this ConversationEntityListing.
+ :return: The last_uri of this ConversationEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ConversationEntityListing.
+ Sets the last_uri of this ConversationEntityListing.
- :param first_uri: The first_uri of this ConversationEntityListing.
+ :param last_uri: The last_uri of this ConversationEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/conversation_profile.py b/build/PureCloudPlatformClientV2/models/conversation_profile.py
new file mode 100644
index 000000000..56fac42e8
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/conversation_profile.py
@@ -0,0 +1,171 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+
+class ConversationProfile(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ ConversationProfile - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'language_code': 'str',
+ 'name': 'str'
+ }
+
+ self.attribute_map = {
+ 'language_code': 'languageCode',
+ 'name': 'name'
+ }
+
+ self._language_code = None
+ self._name = None
+
+ @property
+ def language_code(self) -> str:
+ """
+ Gets the language_code of this ConversationProfile.
+ The language code supported by the conversation profile belonging to a particular project for Dialogflow.
+
+ :return: The language_code of this ConversationProfile.
+ :rtype: str
+ """
+ return self._language_code
+
+ @language_code.setter
+ def language_code(self, language_code: str) -> None:
+ """
+ Sets the language_code of this ConversationProfile.
+ The language code supported by the conversation profile belonging to a particular project for Dialogflow.
+
+ :param language_code: The language_code of this ConversationProfile.
+ :type: str
+ """
+ if isinstance(language_code, int):
+ language_code = str(language_code)
+ allowed_values = ["en", "en-AU", "en-CA", "en-GB", "en-IN", "en-US"]
+ if language_code.lower() not in map(str.lower, allowed_values):
+ # print("Invalid value for language_code -> " + language_code)
+ self._language_code = "outdated_sdk_version"
+ else:
+ self._language_code = language_code
+
+ @property
+ def name(self) -> str:
+ """
+ Gets the name of this ConversationProfile.
+ The name of the conversation profile belonging to a particular project for Dialogflow
+
+ :return: The name of this ConversationProfile.
+ :rtype: str
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name: str) -> None:
+ """
+ Sets the name of this ConversationProfile.
+ The name of the conversation profile belonging to a particular project for Dialogflow
+
+ :param name: The name of this ConversationProfile.
+ :type: str
+ """
+
+
+ self._name = name
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/copilot.py b/build/PureCloudPlatformClientV2/models/copilot.py
new file mode 100644
index 000000000..5768ea86f
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/copilot.py
@@ -0,0 +1,421 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import AnswerGenerationConfig
+ from . import KnowledgeAnswerConfig
+ from . import NluConfig
+ from . import RuleEngineConfig
+ from . import SummaryGenerationConfig
+ from . import WrapupCodePredictionConfig
+
+class Copilot(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ Copilot - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'enabled': 'bool',
+ 'live_on_queue': 'bool',
+ 'default_language': 'str',
+ 'knowledge_answer_config': 'KnowledgeAnswerConfig',
+ 'summary_generation_config': 'SummaryGenerationConfig',
+ 'wrapup_code_prediction_config': 'WrapupCodePredictionConfig',
+ 'answer_generation_config': 'AnswerGenerationConfig',
+ 'nlu_engine_type': 'str',
+ 'nlu_config': 'NluConfig',
+ 'rule_engine_config': 'RuleEngineConfig',
+ 'self_uri': 'str'
+ }
+
+ self.attribute_map = {
+ 'enabled': 'enabled',
+ 'live_on_queue': 'liveOnQueue',
+ 'default_language': 'defaultLanguage',
+ 'knowledge_answer_config': 'knowledgeAnswerConfig',
+ 'summary_generation_config': 'summaryGenerationConfig',
+ 'wrapup_code_prediction_config': 'wrapupCodePredictionConfig',
+ 'answer_generation_config': 'answerGenerationConfig',
+ 'nlu_engine_type': 'nluEngineType',
+ 'nlu_config': 'nluConfig',
+ 'rule_engine_config': 'ruleEngineConfig',
+ 'self_uri': 'selfUri'
+ }
+
+ self._enabled = None
+ self._live_on_queue = None
+ self._default_language = None
+ self._knowledge_answer_config = None
+ self._summary_generation_config = None
+ self._wrapup_code_prediction_config = None
+ self._answer_generation_config = None
+ self._nlu_engine_type = None
+ self._nlu_config = None
+ self._rule_engine_config = None
+ self._self_uri = None
+
+ @property
+ def enabled(self) -> bool:
+ """
+ Gets the enabled of this Copilot.
+ Copilot is enabled.
+
+ :return: The enabled of this Copilot.
+ :rtype: bool
+ """
+ return self._enabled
+
+ @enabled.setter
+ def enabled(self, enabled: bool) -> None:
+ """
+ Sets the enabled of this Copilot.
+ Copilot is enabled.
+
+ :param enabled: The enabled of this Copilot.
+ :type: bool
+ """
+
+
+ self._enabled = enabled
+
+ @property
+ def live_on_queue(self) -> bool:
+ """
+ Gets the live_on_queue of this Copilot.
+ Copilot is live on selected queue.
+
+ :return: The live_on_queue of this Copilot.
+ :rtype: bool
+ """
+ return self._live_on_queue
+
+ @live_on_queue.setter
+ def live_on_queue(self, live_on_queue: bool) -> None:
+ """
+ Sets the live_on_queue of this Copilot.
+ Copilot is live on selected queue.
+
+ :param live_on_queue: The live_on_queue of this Copilot.
+ :type: bool
+ """
+
+
+ self._live_on_queue = live_on_queue
+
+ @property
+ def default_language(self) -> str:
+ """
+ Gets the default_language of this Copilot.
+ Copilot default language, e.g. [en-US, es-US, es-ES]. Once set, it can not be modified.
+
+ :return: The default_language of this Copilot.
+ :rtype: str
+ """
+ return self._default_language
+
+ @default_language.setter
+ def default_language(self, default_language: str) -> None:
+ """
+ Sets the default_language of this Copilot.
+ Copilot default language, e.g. [en-US, es-US, es-ES]. Once set, it can not be modified.
+
+ :param default_language: The default_language of this Copilot.
+ :type: str
+ """
+
+
+ self._default_language = default_language
+
+ @property
+ def knowledge_answer_config(self) -> 'KnowledgeAnswerConfig':
+ """
+ Gets the knowledge_answer_config of this Copilot.
+ Knowledge answer configuration.
+
+ :return: The knowledge_answer_config of this Copilot.
+ :rtype: KnowledgeAnswerConfig
+ """
+ return self._knowledge_answer_config
+
+ @knowledge_answer_config.setter
+ def knowledge_answer_config(self, knowledge_answer_config: 'KnowledgeAnswerConfig') -> None:
+ """
+ Sets the knowledge_answer_config of this Copilot.
+ Knowledge answer configuration.
+
+ :param knowledge_answer_config: The knowledge_answer_config of this Copilot.
+ :type: KnowledgeAnswerConfig
+ """
+
+
+ self._knowledge_answer_config = knowledge_answer_config
+
+ @property
+ def summary_generation_config(self) -> 'SummaryGenerationConfig':
+ """
+ Gets the summary_generation_config of this Copilot.
+ Copilot generated summary configuration.
+
+ :return: The summary_generation_config of this Copilot.
+ :rtype: SummaryGenerationConfig
+ """
+ return self._summary_generation_config
+
+ @summary_generation_config.setter
+ def summary_generation_config(self, summary_generation_config: 'SummaryGenerationConfig') -> None:
+ """
+ Sets the summary_generation_config of this Copilot.
+ Copilot generated summary configuration.
+
+ :param summary_generation_config: The summary_generation_config of this Copilot.
+ :type: SummaryGenerationConfig
+ """
+
+
+ self._summary_generation_config = summary_generation_config
+
+ @property
+ def wrapup_code_prediction_config(self) -> 'WrapupCodePredictionConfig':
+ """
+ Gets the wrapup_code_prediction_config of this Copilot.
+ Copilot generated wrapup code prediction configuration.
+
+ :return: The wrapup_code_prediction_config of this Copilot.
+ :rtype: WrapupCodePredictionConfig
+ """
+ return self._wrapup_code_prediction_config
+
+ @wrapup_code_prediction_config.setter
+ def wrapup_code_prediction_config(self, wrapup_code_prediction_config: 'WrapupCodePredictionConfig') -> None:
+ """
+ Sets the wrapup_code_prediction_config of this Copilot.
+ Copilot generated wrapup code prediction configuration.
+
+ :param wrapup_code_prediction_config: The wrapup_code_prediction_config of this Copilot.
+ :type: WrapupCodePredictionConfig
+ """
+
+
+ self._wrapup_code_prediction_config = wrapup_code_prediction_config
+
+ @property
+ def answer_generation_config(self) -> 'AnswerGenerationConfig':
+ """
+ Gets the answer_generation_config of this Copilot.
+ Answer generation configuration.
+
+ :return: The answer_generation_config of this Copilot.
+ :rtype: AnswerGenerationConfig
+ """
+ return self._answer_generation_config
+
+ @answer_generation_config.setter
+ def answer_generation_config(self, answer_generation_config: 'AnswerGenerationConfig') -> None:
+ """
+ Sets the answer_generation_config of this Copilot.
+ Answer generation configuration.
+
+ :param answer_generation_config: The answer_generation_config of this Copilot.
+ :type: AnswerGenerationConfig
+ """
+
+
+ self._answer_generation_config = answer_generation_config
+
+ @property
+ def nlu_engine_type(self) -> str:
+ """
+ Gets the nlu_engine_type of this Copilot.
+ Language understanding engine type.
+
+ :return: The nlu_engine_type of this Copilot.
+ :rtype: str
+ """
+ return self._nlu_engine_type
+
+ @nlu_engine_type.setter
+ def nlu_engine_type(self, nlu_engine_type: str) -> None:
+ """
+ Sets the nlu_engine_type of this Copilot.
+ Language understanding engine type.
+
+ :param nlu_engine_type: The nlu_engine_type of this Copilot.
+ :type: str
+ """
+ if isinstance(nlu_engine_type, int):
+ nlu_engine_type = str(nlu_engine_type)
+ allowed_values = ["NluV3"]
+ if nlu_engine_type.lower() not in map(str.lower, allowed_values):
+ # print("Invalid value for nlu_engine_type -> " + nlu_engine_type)
+ self._nlu_engine_type = "outdated_sdk_version"
+ else:
+ self._nlu_engine_type = nlu_engine_type
+
+ @property
+ def nlu_config(self) -> 'NluConfig':
+ """
+ Gets the nlu_config of this Copilot.
+ NLU configuration.
+
+ :return: The nlu_config of this Copilot.
+ :rtype: NluConfig
+ """
+ return self._nlu_config
+
+ @nlu_config.setter
+ def nlu_config(self, nlu_config: 'NluConfig') -> None:
+ """
+ Sets the nlu_config of this Copilot.
+ NLU configuration.
+
+ :param nlu_config: The nlu_config of this Copilot.
+ :type: NluConfig
+ """
+
+
+ self._nlu_config = nlu_config
+
+ @property
+ def rule_engine_config(self) -> 'RuleEngineConfig':
+ """
+ Gets the rule_engine_config of this Copilot.
+ Rule engine configuration.
+
+ :return: The rule_engine_config of this Copilot.
+ :rtype: RuleEngineConfig
+ """
+ return self._rule_engine_config
+
+ @rule_engine_config.setter
+ def rule_engine_config(self, rule_engine_config: 'RuleEngineConfig') -> None:
+ """
+ Sets the rule_engine_config of this Copilot.
+ Rule engine configuration.
+
+ :param rule_engine_config: The rule_engine_config of this Copilot.
+ :type: RuleEngineConfig
+ """
+
+
+ self._rule_engine_config = rule_engine_config
+
+ @property
+ def self_uri(self) -> str:
+ """
+ Gets the self_uri of this Copilot.
+ The URI for this object
+
+ :return: The self_uri of this Copilot.
+ :rtype: str
+ """
+ return self._self_uri
+
+ @self_uri.setter
+ def self_uri(self, self_uri: str) -> None:
+ """
+ Sets the self_uri of this Copilot.
+ The URI for this object
+
+ :param self_uri: The self_uri of this Copilot.
+ :type: str
+ """
+
+
+ self._self_uri = self_uri
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/copilot_action.py b/build/PureCloudPlatformClientV2/models/copilot_action.py
new file mode 100644
index 000000000..8c0214b72
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/copilot_action.py
@@ -0,0 +1,171 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+
+class CopilotAction(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ CopilotAction - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'action_type': 'str',
+ 'attributes': 'dict(str, str)'
+ }
+
+ self.attribute_map = {
+ 'action_type': 'actionType',
+ 'attributes': 'attributes'
+ }
+
+ self._action_type = None
+ self._attributes = None
+
+ @property
+ def action_type(self) -> str:
+ """
+ Gets the action_type of this CopilotAction.
+ Type of action.
+
+ :return: The action_type of this CopilotAction.
+ :rtype: str
+ """
+ return self._action_type
+
+ @action_type.setter
+ def action_type(self, action_type: str) -> None:
+ """
+ Sets the action_type of this CopilotAction.
+ Type of action.
+
+ :param action_type: The action_type of this CopilotAction.
+ :type: str
+ """
+ if isinstance(action_type, int):
+ action_type = str(action_type)
+ allowed_values = ["KnowledgeArticle", "CannedResponse", "Script"]
+ if action_type.lower() not in map(str.lower, allowed_values):
+ # print("Invalid value for action_type -> " + action_type)
+ self._action_type = "outdated_sdk_version"
+ else:
+ self._action_type = action_type
+
+ @property
+ def attributes(self) -> Dict[str, str]:
+ """
+ Gets the attributes of this CopilotAction.
+ Action specific attributes, if any. Maximum 100 of string key-value pair allowed.
+
+ :return: The attributes of this CopilotAction.
+ :rtype: dict(str, str)
+ """
+ return self._attributes
+
+ @attributes.setter
+ def attributes(self, attributes: Dict[str, str]) -> None:
+ """
+ Sets the attributes of this CopilotAction.
+ Action specific attributes, if any. Maximum 100 of string key-value pair allowed.
+
+ :param attributes: The attributes of this CopilotAction.
+ :type: dict(str, str)
+ """
+
+
+ self._attributes = attributes
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/copilot_condition.py b/build/PureCloudPlatformClientV2/models/copilot_condition.py
new file mode 100644
index 000000000..5d4ee1246
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/copilot_condition.py
@@ -0,0 +1,171 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+
+class CopilotCondition(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ CopilotCondition - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'condition_type': 'str',
+ 'condition_values': 'list[str]'
+ }
+
+ self.attribute_map = {
+ 'condition_type': 'conditionType',
+ 'condition_values': 'conditionValues'
+ }
+
+ self._condition_type = None
+ self._condition_values = None
+
+ @property
+ def condition_type(self) -> str:
+ """
+ Gets the condition_type of this CopilotCondition.
+ Type of condition.
+
+ :return: The condition_type of this CopilotCondition.
+ :rtype: str
+ """
+ return self._condition_type
+
+ @condition_type.setter
+ def condition_type(self, condition_type: str) -> None:
+ """
+ Sets the condition_type of this CopilotCondition.
+ Type of condition.
+
+ :param condition_type: The condition_type of this CopilotCondition.
+ :type: str
+ """
+ if isinstance(condition_type, int):
+ condition_type = str(condition_type)
+ allowed_values = ["Intent", "ConversationStart", "ConversationTransfer", "ConversationEnd"]
+ if condition_type.lower() not in map(str.lower, allowed_values):
+ # print("Invalid value for condition_type -> " + condition_type)
+ self._condition_type = "outdated_sdk_version"
+ else:
+ self._condition_type = condition_type
+
+ @property
+ def condition_values(self) -> List[str]:
+ """
+ Gets the condition_values of this CopilotCondition.
+ Condition values.
+
+ :return: The condition_values of this CopilotCondition.
+ :rtype: list[str]
+ """
+ return self._condition_values
+
+ @condition_values.setter
+ def condition_values(self, condition_values: List[str]) -> None:
+ """
+ Sets the condition_values of this CopilotCondition.
+ Condition values.
+
+ :param condition_values: The condition_values of this CopilotCondition.
+ :type: list[str]
+ """
+
+
+ self._condition_values = condition_values
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/copilot_fallback_action.py b/build/PureCloudPlatformClientV2/models/copilot_fallback_action.py
new file mode 100644
index 000000000..7ab0975bb
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/copilot_fallback_action.py
@@ -0,0 +1,171 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+
+class CopilotFallbackAction(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ CopilotFallbackAction - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'action_type': 'str',
+ 'attributes': 'dict(str, str)'
+ }
+
+ self.attribute_map = {
+ 'action_type': 'actionType',
+ 'attributes': 'attributes'
+ }
+
+ self._action_type = None
+ self._attributes = None
+
+ @property
+ def action_type(self) -> str:
+ """
+ Gets the action_type of this CopilotFallbackAction.
+ Type of action.
+
+ :return: The action_type of this CopilotFallbackAction.
+ :rtype: str
+ """
+ return self._action_type
+
+ @action_type.setter
+ def action_type(self, action_type: str) -> None:
+ """
+ Sets the action_type of this CopilotFallbackAction.
+ Type of action.
+
+ :param action_type: The action_type of this CopilotFallbackAction.
+ :type: str
+ """
+ if isinstance(action_type, int):
+ action_type = str(action_type)
+ allowed_values = ["KnowledgeArticle", "CannedResponse", "Script", "KnowledgeSearch"]
+ if action_type.lower() not in map(str.lower, allowed_values):
+ # print("Invalid value for action_type -> " + action_type)
+ self._action_type = "outdated_sdk_version"
+ else:
+ self._action_type = action_type
+
+ @property
+ def attributes(self) -> Dict[str, str]:
+ """
+ Gets the attributes of this CopilotFallbackAction.
+ Action specific attributes, if any. Maximum 100 of string key-value pair allowed.
+
+ :return: The attributes of this CopilotFallbackAction.
+ :rtype: dict(str, str)
+ """
+ return self._attributes
+
+ @attributes.setter
+ def attributes(self, attributes: Dict[str, str]) -> None:
+ """
+ Sets the attributes of this CopilotFallbackAction.
+ Action specific attributes, if any. Maximum 100 of string key-value pair allowed.
+
+ :param attributes: The attributes of this CopilotFallbackAction.
+ :type: dict(str, str)
+ """
+
+
+ self._attributes = attributes
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/copilot_nlu_domain.py b/build/PureCloudPlatformClientV2/models/copilot_nlu_domain.py
new file mode 100644
index 000000000..ee2ae6a95
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/copilot_nlu_domain.py
@@ -0,0 +1,222 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import CopilotNluDomainVersion
+
+class CopilotNluDomain(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ CopilotNluDomain - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'id': 'str',
+ 'use_latest_version': 'bool',
+ 'version': 'CopilotNluDomainVersion',
+ 'self_uri': 'str'
+ }
+
+ self.attribute_map = {
+ 'id': 'id',
+ 'use_latest_version': 'useLatestVersion',
+ 'version': 'version',
+ 'self_uri': 'selfUri'
+ }
+
+ self._id = None
+ self._use_latest_version = None
+ self._version = None
+ self._self_uri = None
+
+ @property
+ def id(self) -> str:
+ """
+ Gets the id of this CopilotNluDomain.
+ Id of the NLU domain.
+
+ :return: The id of this CopilotNluDomain.
+ :rtype: str
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id: str) -> None:
+ """
+ Sets the id of this CopilotNluDomain.
+ Id of the NLU domain.
+
+ :param id: The id of this CopilotNluDomain.
+ :type: str
+ """
+
+
+ self._id = id
+
+ @property
+ def use_latest_version(self) -> bool:
+ """
+ Gets the use_latest_version of this CopilotNluDomain.
+ Use the latest version of the NLU domain. If false, version is required.
+
+ :return: The use_latest_version of this CopilotNluDomain.
+ :rtype: bool
+ """
+ return self._use_latest_version
+
+ @use_latest_version.setter
+ def use_latest_version(self, use_latest_version: bool) -> None:
+ """
+ Sets the use_latest_version of this CopilotNluDomain.
+ Use the latest version of the NLU domain. If false, version is required.
+
+ :param use_latest_version: The use_latest_version of this CopilotNluDomain.
+ :type: bool
+ """
+
+
+ self._use_latest_version = use_latest_version
+
+ @property
+ def version(self) -> 'CopilotNluDomainVersion':
+ """
+ Gets the version of this CopilotNluDomain.
+ NLU domain version.
+
+ :return: The version of this CopilotNluDomain.
+ :rtype: CopilotNluDomainVersion
+ """
+ return self._version
+
+ @version.setter
+ def version(self, version: 'CopilotNluDomainVersion') -> None:
+ """
+ Sets the version of this CopilotNluDomain.
+ NLU domain version.
+
+ :param version: The version of this CopilotNluDomain.
+ :type: CopilotNluDomainVersion
+ """
+
+
+ self._version = version
+
+ @property
+ def self_uri(self) -> str:
+ """
+ Gets the self_uri of this CopilotNluDomain.
+ The URI for this object
+
+ :return: The self_uri of this CopilotNluDomain.
+ :rtype: str
+ """
+ return self._self_uri
+
+ @self_uri.setter
+ def self_uri(self, self_uri: str) -> None:
+ """
+ Sets the self_uri of this CopilotNluDomain.
+ The URI for this object
+
+ :param self_uri: The self_uri of this CopilotNluDomain.
+ :type: str
+ """
+
+
+ self._self_uri = self_uri
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/copilot_nlu_domain_version.py b/build/PureCloudPlatformClientV2/models/copilot_nlu_domain_version.py
new file mode 100644
index 000000000..ae1cef357
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/copilot_nlu_domain_version.py
@@ -0,0 +1,166 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+
+class CopilotNluDomainVersion(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ CopilotNluDomainVersion - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'id': 'str',
+ 'self_uri': 'str'
+ }
+
+ self.attribute_map = {
+ 'id': 'id',
+ 'self_uri': 'selfUri'
+ }
+
+ self._id = None
+ self._self_uri = None
+
+ @property
+ def id(self) -> str:
+ """
+ Gets the id of this CopilotNluDomainVersion.
+ Id of the NLU v3 domain version.
+
+ :return: The id of this CopilotNluDomainVersion.
+ :rtype: str
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id: str) -> None:
+ """
+ Sets the id of this CopilotNluDomainVersion.
+ Id of the NLU v3 domain version.
+
+ :param id: The id of this CopilotNluDomainVersion.
+ :type: str
+ """
+
+
+ self._id = id
+
+ @property
+ def self_uri(self) -> str:
+ """
+ Gets the self_uri of this CopilotNluDomainVersion.
+ The URI for this object
+
+ :return: The self_uri of this CopilotNluDomainVersion.
+ :rtype: str
+ """
+ return self._self_uri
+
+ @self_uri.setter
+ def self_uri(self, self_uri: str) -> None:
+ """
+ Sets the self_uri of this CopilotNluDomainVersion.
+ The URI for this object
+
+ :param self_uri: The self_uri of this CopilotNluDomainVersion.
+ :type: str
+ """
+
+
+ self._self_uri = self_uri
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/copilot_rule.py b/build/PureCloudPlatformClientV2/models/copilot_rule.py
new file mode 100644
index 000000000..9100b78b1
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/copilot_rule.py
@@ -0,0 +1,169 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import CopilotAction
+ from . import CopilotCondition
+
+class CopilotRule(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ CopilotRule - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'conditions': 'list[CopilotCondition]',
+ 'actions': 'list[CopilotAction]'
+ }
+
+ self.attribute_map = {
+ 'conditions': 'conditions',
+ 'actions': 'actions'
+ }
+
+ self._conditions = None
+ self._actions = None
+
+ @property
+ def conditions(self) -> List['CopilotCondition']:
+ """
+ Gets the conditions of this CopilotRule.
+ List of conditions to execute actions, must have at least 1 element and maximum 100 elements. Operator in case of multiple conditions: 'OR'.
+
+ :return: The conditions of this CopilotRule.
+ :rtype: list[CopilotCondition]
+ """
+ return self._conditions
+
+ @conditions.setter
+ def conditions(self, conditions: List['CopilotCondition']) -> None:
+ """
+ Sets the conditions of this CopilotRule.
+ List of conditions to execute actions, must have at least 1 element and maximum 100 elements. Operator in case of multiple conditions: 'OR'.
+
+ :param conditions: The conditions of this CopilotRule.
+ :type: list[CopilotCondition]
+ """
+
+
+ self._conditions = conditions
+
+ @property
+ def actions(self) -> List['CopilotAction']:
+ """
+ Gets the actions of this CopilotRule.
+ List of actions to execute, must have at least 1 element and maximum 100 elements.
+
+ :return: The actions of this CopilotRule.
+ :rtype: list[CopilotAction]
+ """
+ return self._actions
+
+ @actions.setter
+ def actions(self, actions: List['CopilotAction']) -> None:
+ """
+ Sets the actions of this CopilotRule.
+ List of actions to execute, must have at least 1 element and maximum 100 elements.
+
+ :param actions: The actions of this CopilotRule.
+ :type: list[CopilotAction]
+ """
+
+
+ self._actions = actions
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/credential_info_listing.py b/build/PureCloudPlatformClientV2/models/credential_info_listing.py
index 1d7bc9956..283f2a481 100644
--- a/build/PureCloudPlatformClientV2/models/credential_info_listing.py
+++ b/build/PureCloudPlatformClientV2/models/credential_info_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CredentialInfoListing.
+ Gets the first_uri of this CredentialInfoListing.
- :return: The last_uri of this CredentialInfoListing.
+ :return: The first_uri of this CredentialInfoListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CredentialInfoListing.
+ Sets the first_uri of this CredentialInfoListing.
- :param last_uri: The last_uri of this CredentialInfoListing.
+ :param first_uri: The first_uri of this CredentialInfoListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CredentialInfoListing.
+ Gets the last_uri of this CredentialInfoListing.
- :return: The first_uri of this CredentialInfoListing.
+ :return: The last_uri of this CredentialInfoListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CredentialInfoListing.
+ Sets the last_uri of this CredentialInfoListing.
- :param first_uri: The first_uri of this CredentialInfoListing.
+ :param last_uri: The last_uri of this CredentialInfoListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/credential_type_listing.py b/build/PureCloudPlatformClientV2/models/credential_type_listing.py
index 877abb1b8..88d076227 100644
--- a/build/PureCloudPlatformClientV2/models/credential_type_listing.py
+++ b/build/PureCloudPlatformClientV2/models/credential_type_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this CredentialTypeListing.
+ Gets the first_uri of this CredentialTypeListing.
- :return: The last_uri of this CredentialTypeListing.
+ :return: The first_uri of this CredentialTypeListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this CredentialTypeListing.
+ Sets the first_uri of this CredentialTypeListing.
- :param last_uri: The last_uri of this CredentialTypeListing.
+ :param first_uri: The first_uri of this CredentialTypeListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this CredentialTypeListing.
+ Gets the last_uri of this CredentialTypeListing.
- :return: The first_uri of this CredentialTypeListing.
+ :return: The last_uri of this CredentialTypeListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this CredentialTypeListing.
+ Sets the last_uri of this CredentialTypeListing.
- :param first_uri: The first_uri of this CredentialTypeListing.
+ :param last_uri: The last_uri of this CredentialTypeListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/cursor_external_source_listing.py b/build/PureCloudPlatformClientV2/models/cursor_external_source_listing.py
new file mode 100644
index 000000000..361db47a2
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/cursor_external_source_listing.py
@@ -0,0 +1,250 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import Cursors
+ from . import ExternalSource
+
+class CursorExternalSourceListing(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ CursorExternalSourceListing - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'entities': 'list[ExternalSource]',
+ 'next_uri': 'str',
+ 'self_uri': 'str',
+ 'previous_uri': 'str',
+ 'cursors': 'Cursors'
+ }
+
+ self.attribute_map = {
+ 'entities': 'entities',
+ 'next_uri': 'nextUri',
+ 'self_uri': 'selfUri',
+ 'previous_uri': 'previousUri',
+ 'cursors': 'cursors'
+ }
+
+ self._entities = None
+ self._next_uri = None
+ self._self_uri = None
+ self._previous_uri = None
+ self._cursors = None
+
+ @property
+ def entities(self) -> List['ExternalSource']:
+ """
+ Gets the entities of this CursorExternalSourceListing.
+
+
+ :return: The entities of this CursorExternalSourceListing.
+ :rtype: list[ExternalSource]
+ """
+ return self._entities
+
+ @entities.setter
+ def entities(self, entities: List['ExternalSource']) -> None:
+ """
+ Sets the entities of this CursorExternalSourceListing.
+
+
+ :param entities: The entities of this CursorExternalSourceListing.
+ :type: list[ExternalSource]
+ """
+
+
+ self._entities = entities
+
+ @property
+ def next_uri(self) -> str:
+ """
+ Gets the next_uri of this CursorExternalSourceListing.
+
+
+ :return: The next_uri of this CursorExternalSourceListing.
+ :rtype: str
+ """
+ return self._next_uri
+
+ @next_uri.setter
+ def next_uri(self, next_uri: str) -> None:
+ """
+ Sets the next_uri of this CursorExternalSourceListing.
+
+
+ :param next_uri: The next_uri of this CursorExternalSourceListing.
+ :type: str
+ """
+
+
+ self._next_uri = next_uri
+
+ @property
+ def self_uri(self) -> str:
+ """
+ Gets the self_uri of this CursorExternalSourceListing.
+
+
+ :return: The self_uri of this CursorExternalSourceListing.
+ :rtype: str
+ """
+ return self._self_uri
+
+ @self_uri.setter
+ def self_uri(self, self_uri: str) -> None:
+ """
+ Sets the self_uri of this CursorExternalSourceListing.
+
+
+ :param self_uri: The self_uri of this CursorExternalSourceListing.
+ :type: str
+ """
+
+
+ self._self_uri = self_uri
+
+ @property
+ def previous_uri(self) -> str:
+ """
+ Gets the previous_uri of this CursorExternalSourceListing.
+
+
+ :return: The previous_uri of this CursorExternalSourceListing.
+ :rtype: str
+ """
+ return self._previous_uri
+
+ @previous_uri.setter
+ def previous_uri(self, previous_uri: str) -> None:
+ """
+ Sets the previous_uri of this CursorExternalSourceListing.
+
+
+ :param previous_uri: The previous_uri of this CursorExternalSourceListing.
+ :type: str
+ """
+
+
+ self._previous_uri = previous_uri
+
+ @property
+ def cursors(self) -> 'Cursors':
+ """
+ Gets the cursors of this CursorExternalSourceListing.
+ The cursor that points to the next set of entities being returned.
+
+ :return: The cursors of this CursorExternalSourceListing.
+ :rtype: Cursors
+ """
+ return self._cursors
+
+ @cursors.setter
+ def cursors(self, cursors: 'Cursors') -> None:
+ """
+ Sets the cursors of this CursorExternalSourceListing.
+ The cursor that points to the next set of entities being returned.
+
+ :param cursors: The cursors of this CursorExternalSourceListing.
+ :type: Cursors
+ """
+
+
+ self._cursors = cursors
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/customer_end_detail_event_topic_customer_end_event.py b/build/PureCloudPlatformClientV2/models/customer_end_detail_event_topic_customer_end_event.py
index 421266484..a787cc6f8 100644
--- a/build/PureCloudPlatformClientV2/models/customer_end_detail_event_topic_customer_end_event.py
+++ b/build/PureCloudPlatformClientV2/models/customer_end_detail_event_topic_customer_end_event.py
@@ -592,7 +592,7 @@ def message_type(self, message_type: str) -> None:
"""
if isinstance(message_type, int):
message_type = str(message_type)
- allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM"]
+ allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM", "APPLE"]
if message_type.lower() not in map(str.lower, allowed_values):
# print("Invalid value for message_type -> " + message_type)
self._message_type = "outdated_sdk_version"
diff --git a/build/PureCloudPlatformClientV2/models/customer_start_detail_event_topic_customer_start_event.py b/build/PureCloudPlatformClientV2/models/customer_start_detail_event_topic_customer_start_event.py
index 03e110bcc..d79d8d076 100644
--- a/build/PureCloudPlatformClientV2/models/customer_start_detail_event_topic_customer_start_event.py
+++ b/build/PureCloudPlatformClientV2/models/customer_start_detail_event_topic_customer_start_event.py
@@ -562,7 +562,7 @@ def message_type(self, message_type: str) -> None:
"""
if isinstance(message_type, int):
message_type = str(message_type)
- allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM"]
+ allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM", "APPLE"]
if message_type.lower() not in map(str.lower, allowed_values):
# print("Invalid value for message_type -> " + message_type)
self._message_type = "outdated_sdk_version"
diff --git a/build/PureCloudPlatformClientV2/models/dashboard_configuration_listing.py b/build/PureCloudPlatformClientV2/models/dashboard_configuration_listing.py
index aaf12df27..bb1b73ded 100644
--- a/build/PureCloudPlatformClientV2/models/dashboard_configuration_listing.py
+++ b/build/PureCloudPlatformClientV2/models/dashboard_configuration_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DashboardConfigurationListing.
+ Gets the first_uri of this DashboardConfigurationListing.
- :return: The last_uri of this DashboardConfigurationListing.
+ :return: The first_uri of this DashboardConfigurationListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DashboardConfigurationListing.
+ Sets the first_uri of this DashboardConfigurationListing.
- :param last_uri: The last_uri of this DashboardConfigurationListing.
+ :param first_uri: The first_uri of this DashboardConfigurationListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DashboardConfigurationListing.
+ Gets the last_uri of this DashboardConfigurationListing.
- :return: The first_uri of this DashboardConfigurationListing.
+ :return: The last_uri of this DashboardConfigurationListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DashboardConfigurationListing.
+ Sets the last_uri of this DashboardConfigurationListing.
- :param first_uri: The first_uri of this DashboardConfigurationListing.
+ :param last_uri: The last_uri of this DashboardConfigurationListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/dashboard_user_listing.py b/build/PureCloudPlatformClientV2/models/dashboard_user_listing.py
index 1f1d250de..627bc65f0 100644
--- a/build/PureCloudPlatformClientV2/models/dashboard_user_listing.py
+++ b/build/PureCloudPlatformClientV2/models/dashboard_user_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DashboardUserListing.
+ Gets the first_uri of this DashboardUserListing.
- :return: The last_uri of this DashboardUserListing.
+ :return: The first_uri of this DashboardUserListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DashboardUserListing.
+ Sets the first_uri of this DashboardUserListing.
- :param last_uri: The last_uri of this DashboardUserListing.
+ :param first_uri: The first_uri of this DashboardUserListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DashboardUserListing.
+ Gets the last_uri of this DashboardUserListing.
- :return: The first_uri of this DashboardUserListing.
+ :return: The last_uri of this DashboardUserListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DashboardUserListing.
+ Sets the last_uri of this DashboardUserListing.
- :param first_uri: The first_uri of this DashboardUserListing.
+ :param last_uri: The last_uri of this DashboardUserListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/data_table_row_entity_listing.py b/build/PureCloudPlatformClientV2/models/data_table_row_entity_listing.py
index 2329087eb..73eff88f4 100644
--- a/build/PureCloudPlatformClientV2/models/data_table_row_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/data_table_row_entity_listing.py
@@ -52,8 +52,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -65,8 +65,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -77,8 +77,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -181,52 +181,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DataTableRowEntityListing.
+ Gets the first_uri of this DataTableRowEntityListing.
- :return: The last_uri of this DataTableRowEntityListing.
+ :return: The first_uri of this DataTableRowEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DataTableRowEntityListing.
+ Sets the first_uri of this DataTableRowEntityListing.
- :param last_uri: The last_uri of this DataTableRowEntityListing.
+ :param first_uri: The first_uri of this DataTableRowEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DataTableRowEntityListing.
+ Gets the last_uri of this DataTableRowEntityListing.
- :return: The first_uri of this DataTableRowEntityListing.
+ :return: The last_uri of this DataTableRowEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DataTableRowEntityListing.
+ Sets the last_uri of this DataTableRowEntityListing.
- :param first_uri: The first_uri of this DataTableRowEntityListing.
+ :param last_uri: The last_uri of this DataTableRowEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/data_tables_domain_entity_listing.py b/build/PureCloudPlatformClientV2/models/data_tables_domain_entity_listing.py
index 0c9ffb711..c8147aef6 100644
--- a/build/PureCloudPlatformClientV2/models/data_tables_domain_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/data_tables_domain_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DataTablesDomainEntityListing.
+ Gets the first_uri of this DataTablesDomainEntityListing.
- :return: The last_uri of this DataTablesDomainEntityListing.
+ :return: The first_uri of this DataTablesDomainEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DataTablesDomainEntityListing.
+ Sets the first_uri of this DataTablesDomainEntityListing.
- :param last_uri: The last_uri of this DataTablesDomainEntityListing.
+ :param first_uri: The first_uri of this DataTablesDomainEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DataTablesDomainEntityListing.
+ Gets the last_uri of this DataTablesDomainEntityListing.
- :return: The first_uri of this DataTablesDomainEntityListing.
+ :return: The last_uri of this DataTablesDomainEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DataTablesDomainEntityListing.
+ Sets the last_uri of this DataTablesDomainEntityListing.
- :param first_uri: The first_uri of this DataTablesDomainEntityListing.
+ :param last_uri: The last_uri of this DataTablesDomainEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/dependency_object_entity_listing.py b/build/PureCloudPlatformClientV2/models/dependency_object_entity_listing.py
index 2039db6dc..26c12d831 100644
--- a/build/PureCloudPlatformClientV2/models/dependency_object_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/dependency_object_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DependencyObjectEntityListing.
+ Gets the first_uri of this DependencyObjectEntityListing.
- :return: The last_uri of this DependencyObjectEntityListing.
+ :return: The first_uri of this DependencyObjectEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DependencyObjectEntityListing.
+ Sets the first_uri of this DependencyObjectEntityListing.
- :param last_uri: The last_uri of this DependencyObjectEntityListing.
+ :param first_uri: The first_uri of this DependencyObjectEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DependencyObjectEntityListing.
+ Gets the last_uri of this DependencyObjectEntityListing.
- :return: The first_uri of this DependencyObjectEntityListing.
+ :return: The last_uri of this DependencyObjectEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DependencyObjectEntityListing.
+ Sets the last_uri of this DependencyObjectEntityListing.
- :param first_uri: The first_uri of this DependencyObjectEntityListing.
+ :param last_uri: The last_uri of this DependencyObjectEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/dependency_type_entity_listing.py b/build/PureCloudPlatformClientV2/models/dependency_type_entity_listing.py
index 5c37fe9fd..233acb0ed 100644
--- a/build/PureCloudPlatformClientV2/models/dependency_type_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/dependency_type_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DependencyTypeEntityListing.
+ Gets the first_uri of this DependencyTypeEntityListing.
- :return: The last_uri of this DependencyTypeEntityListing.
+ :return: The first_uri of this DependencyTypeEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DependencyTypeEntityListing.
+ Sets the first_uri of this DependencyTypeEntityListing.
- :param last_uri: The last_uri of this DependencyTypeEntityListing.
+ :param first_uri: The first_uri of this DependencyTypeEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DependencyTypeEntityListing.
+ Gets the last_uri of this DependencyTypeEntityListing.
- :return: The first_uri of this DependencyTypeEntityListing.
+ :return: The last_uri of this DependencyTypeEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DependencyTypeEntityListing.
+ Sets the last_uri of this DependencyTypeEntityListing.
- :param first_uri: The first_uri of this DependencyTypeEntityListing.
+ :param last_uri: The last_uri of this DependencyTypeEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/development_activity_listing.py b/build/PureCloudPlatformClientV2/models/development_activity_listing.py
index 3571bb727..f4c8a4c6c 100644
--- a/build/PureCloudPlatformClientV2/models/development_activity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/development_activity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DevelopmentActivityListing.
+ Gets the first_uri of this DevelopmentActivityListing.
- :return: The last_uri of this DevelopmentActivityListing.
+ :return: The first_uri of this DevelopmentActivityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DevelopmentActivityListing.
+ Sets the first_uri of this DevelopmentActivityListing.
- :param last_uri: The last_uri of this DevelopmentActivityListing.
+ :param first_uri: The first_uri of this DevelopmentActivityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DevelopmentActivityListing.
+ Gets the last_uri of this DevelopmentActivityListing.
- :return: The first_uri of this DevelopmentActivityListing.
+ :return: The last_uri of this DevelopmentActivityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DevelopmentActivityListing.
+ Sets the last_uri of this DevelopmentActivityListing.
- :param first_uri: The first_uri of this DevelopmentActivityListing.
+ :param last_uri: The last_uri of this DevelopmentActivityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/dialer_event_entity_listing.py b/build/PureCloudPlatformClientV2/models/dialer_event_entity_listing.py
index 158cb0be5..faff55803 100644
--- a/build/PureCloudPlatformClientV2/models/dialer_event_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/dialer_event_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DialerEventEntityListing.
+ Gets the first_uri of this DialerEventEntityListing.
- :return: The last_uri of this DialerEventEntityListing.
+ :return: The first_uri of this DialerEventEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DialerEventEntityListing.
+ Sets the first_uri of this DialerEventEntityListing.
- :param last_uri: The last_uri of this DialerEventEntityListing.
+ :param first_uri: The first_uri of this DialerEventEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DialerEventEntityListing.
+ Gets the last_uri of this DialerEventEntityListing.
- :return: The first_uri of this DialerEventEntityListing.
+ :return: The last_uri of this DialerEventEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DialerEventEntityListing.
+ Sets the last_uri of this DialerEventEntityListing.
- :param first_uri: The first_uri of this DialerEventEntityListing.
+ :param last_uri: The last_uri of this DialerEventEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/dialogflow_agent_summary_entity_listing.py b/build/PureCloudPlatformClientV2/models/dialogflow_agent_summary_entity_listing.py
index 8721627c4..7ffb801a7 100644
--- a/build/PureCloudPlatformClientV2/models/dialogflow_agent_summary_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/dialogflow_agent_summary_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DialogflowAgentSummaryEntityListing.
+ Gets the first_uri of this DialogflowAgentSummaryEntityListing.
- :return: The last_uri of this DialogflowAgentSummaryEntityListing.
+ :return: The first_uri of this DialogflowAgentSummaryEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DialogflowAgentSummaryEntityListing.
+ Sets the first_uri of this DialogflowAgentSummaryEntityListing.
- :param last_uri: The last_uri of this DialogflowAgentSummaryEntityListing.
+ :param first_uri: The first_uri of this DialogflowAgentSummaryEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DialogflowAgentSummaryEntityListing.
+ Gets the last_uri of this DialogflowAgentSummaryEntityListing.
- :return: The first_uri of this DialogflowAgentSummaryEntityListing.
+ :return: The last_uri of this DialogflowAgentSummaryEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DialogflowAgentSummaryEntityListing.
+ Sets the last_uri of this DialogflowAgentSummaryEntityListing.
- :param first_uri: The first_uri of this DialogflowAgentSummaryEntityListing.
+ :param last_uri: The last_uri of this DialogflowAgentSummaryEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/dialogflow_cx_agent_summary_entity_listing.py b/build/PureCloudPlatformClientV2/models/dialogflow_cx_agent_summary_entity_listing.py
index f2af2c4a3..7914fd3cc 100644
--- a/build/PureCloudPlatformClientV2/models/dialogflow_cx_agent_summary_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/dialogflow_cx_agent_summary_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DialogflowCXAgentSummaryEntityListing.
+ Gets the first_uri of this DialogflowCXAgentSummaryEntityListing.
- :return: The last_uri of this DialogflowCXAgentSummaryEntityListing.
+ :return: The first_uri of this DialogflowCXAgentSummaryEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DialogflowCXAgentSummaryEntityListing.
+ Sets the first_uri of this DialogflowCXAgentSummaryEntityListing.
- :param last_uri: The last_uri of this DialogflowCXAgentSummaryEntityListing.
+ :param first_uri: The first_uri of this DialogflowCXAgentSummaryEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DialogflowCXAgentSummaryEntityListing.
+ Gets the last_uri of this DialogflowCXAgentSummaryEntityListing.
- :return: The first_uri of this DialogflowCXAgentSummaryEntityListing.
+ :return: The last_uri of this DialogflowCXAgentSummaryEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DialogflowCXAgentSummaryEntityListing.
+ Sets the last_uri of this DialogflowCXAgentSummaryEntityListing.
- :param first_uri: The first_uri of this DialogflowCXAgentSummaryEntityListing.
+ :param last_uri: The last_uri of this DialogflowCXAgentSummaryEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/did_entity_listing.py b/build/PureCloudPlatformClientV2/models/did_entity_listing.py
index 244b8da43..f67fae85e 100644
--- a/build/PureCloudPlatformClientV2/models/did_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/did_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DIDEntityListing.
+ Gets the first_uri of this DIDEntityListing.
- :return: The last_uri of this DIDEntityListing.
+ :return: The first_uri of this DIDEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DIDEntityListing.
+ Sets the first_uri of this DIDEntityListing.
- :param last_uri: The last_uri of this DIDEntityListing.
+ :param first_uri: The first_uri of this DIDEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DIDEntityListing.
+ Gets the last_uri of this DIDEntityListing.
- :return: The first_uri of this DIDEntityListing.
+ :return: The last_uri of this DIDEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DIDEntityListing.
+ Sets the last_uri of this DIDEntityListing.
- :param first_uri: The first_uri of this DIDEntityListing.
+ :param last_uri: The last_uri of this DIDEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/did_number_entity_listing.py b/build/PureCloudPlatformClientV2/models/did_number_entity_listing.py
index 86086b904..0d2bafdbe 100644
--- a/build/PureCloudPlatformClientV2/models/did_number_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/did_number_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DIDNumberEntityListing.
+ Gets the first_uri of this DIDNumberEntityListing.
- :return: The last_uri of this DIDNumberEntityListing.
+ :return: The first_uri of this DIDNumberEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DIDNumberEntityListing.
+ Sets the first_uri of this DIDNumberEntityListing.
- :param last_uri: The last_uri of this DIDNumberEntityListing.
+ :param first_uri: The first_uri of this DIDNumberEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DIDNumberEntityListing.
+ Gets the last_uri of this DIDNumberEntityListing.
- :return: The first_uri of this DIDNumberEntityListing.
+ :return: The last_uri of this DIDNumberEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DIDNumberEntityListing.
+ Sets the last_uri of this DIDNumberEntityListing.
- :param first_uri: The first_uri of this DIDNumberEntityListing.
+ :param last_uri: The last_uri of this DIDNumberEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/did_pool_entity_listing.py b/build/PureCloudPlatformClientV2/models/did_pool_entity_listing.py
index 0688d1566..5b8305011 100644
--- a/build/PureCloudPlatformClientV2/models/did_pool_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/did_pool_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DIDPoolEntityListing.
+ Gets the first_uri of this DIDPoolEntityListing.
- :return: The last_uri of this DIDPoolEntityListing.
+ :return: The first_uri of this DIDPoolEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DIDPoolEntityListing.
+ Sets the first_uri of this DIDPoolEntityListing.
- :param last_uri: The last_uri of this DIDPoolEntityListing.
+ :param first_uri: The first_uri of this DIDPoolEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DIDPoolEntityListing.
+ Gets the last_uri of this DIDPoolEntityListing.
- :return: The first_uri of this DIDPoolEntityListing.
+ :return: The last_uri of this DIDPoolEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DIDPoolEntityListing.
+ Sets the last_uri of this DIDPoolEntityListing.
- :param first_uri: The first_uri of this DIDPoolEntityListing.
+ :param last_uri: The last_uri of this DIDPoolEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/digital_rule_set_entity_listing.py b/build/PureCloudPlatformClientV2/models/digital_rule_set_entity_listing.py
index a9c5f9818..27ea7d0e3 100644
--- a/build/PureCloudPlatformClientV2/models/digital_rule_set_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/digital_rule_set_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DigitalRuleSetEntityListing.
+ Gets the first_uri of this DigitalRuleSetEntityListing.
- :return: The last_uri of this DigitalRuleSetEntityListing.
+ :return: The first_uri of this DigitalRuleSetEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DigitalRuleSetEntityListing.
+ Sets the first_uri of this DigitalRuleSetEntityListing.
- :param last_uri: The last_uri of this DigitalRuleSetEntityListing.
+ :param first_uri: The first_uri of this DigitalRuleSetEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DigitalRuleSetEntityListing.
+ Gets the last_uri of this DigitalRuleSetEntityListing.
- :return: The first_uri of this DigitalRuleSetEntityListing.
+ :return: The last_uri of this DigitalRuleSetEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DigitalRuleSetEntityListing.
+ Sets the last_uri of this DigitalRuleSetEntityListing.
- :param first_uri: The first_uri of this DigitalRuleSetEntityListing.
+ :param last_uri: The last_uri of this DigitalRuleSetEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/directory_user_devices_listing.py b/build/PureCloudPlatformClientV2/models/directory_user_devices_listing.py
index f35c1fc7c..8f23efe33 100644
--- a/build/PureCloudPlatformClientV2/models/directory_user_devices_listing.py
+++ b/build/PureCloudPlatformClientV2/models/directory_user_devices_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DirectoryUserDevicesListing.
+ Gets the first_uri of this DirectoryUserDevicesListing.
- :return: The last_uri of this DirectoryUserDevicesListing.
+ :return: The first_uri of this DirectoryUserDevicesListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DirectoryUserDevicesListing.
+ Sets the first_uri of this DirectoryUserDevicesListing.
- :param last_uri: The last_uri of this DirectoryUserDevicesListing.
+ :param first_uri: The first_uri of this DirectoryUserDevicesListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DirectoryUserDevicesListing.
+ Gets the last_uri of this DirectoryUserDevicesListing.
- :return: The first_uri of this DirectoryUserDevicesListing.
+ :return: The last_uri of this DirectoryUserDevicesListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DirectoryUserDevicesListing.
+ Sets the last_uri of this DirectoryUserDevicesListing.
- :param first_uri: The first_uri of this DirectoryUserDevicesListing.
+ :param last_uri: The last_uri of this DirectoryUserDevicesListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/divs_permitted_entity_listing.py b/build/PureCloudPlatformClientV2/models/divs_permitted_entity_listing.py
index fc4b22a62..6c92ab5eb 100644
--- a/build/PureCloudPlatformClientV2/models/divs_permitted_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/divs_permitted_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'all_divs_permitted': 'bool',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'all_divs_permitted': 'allDivsPermitted',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._all_divs_permitted = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def all_divs_permitted(self, all_divs_permitted: bool) -> None:
self._all_divs_permitted = all_divs_permitted
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DivsPermittedEntityListing.
+ Gets the first_uri of this DivsPermittedEntityListing.
- :return: The last_uri of this DivsPermittedEntityListing.
+ :return: The first_uri of this DivsPermittedEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DivsPermittedEntityListing.
+ Sets the first_uri of this DivsPermittedEntityListing.
- :param last_uri: The last_uri of this DivsPermittedEntityListing.
+ :param first_uri: The first_uri of this DivsPermittedEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DivsPermittedEntityListing.
+ Gets the last_uri of this DivsPermittedEntityListing.
- :return: The first_uri of this DivsPermittedEntityListing.
+ :return: The last_uri of this DivsPermittedEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DivsPermittedEntityListing.
+ Sets the last_uri of this DivsPermittedEntityListing.
- :param first_uri: The first_uri of this DivsPermittedEntityListing.
+ :param last_uri: The last_uri of this DivsPermittedEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/dnc_list_division_view_listing.py b/build/PureCloudPlatformClientV2/models/dnc_list_division_view_listing.py
index ce30ba41f..0767aa889 100644
--- a/build/PureCloudPlatformClientV2/models/dnc_list_division_view_listing.py
+++ b/build/PureCloudPlatformClientV2/models/dnc_list_division_view_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DncListDivisionViewListing.
+ Gets the first_uri of this DncListDivisionViewListing.
- :return: The last_uri of this DncListDivisionViewListing.
+ :return: The first_uri of this DncListDivisionViewListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DncListDivisionViewListing.
+ Sets the first_uri of this DncListDivisionViewListing.
- :param last_uri: The last_uri of this DncListDivisionViewListing.
+ :param first_uri: The first_uri of this DncListDivisionViewListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DncListDivisionViewListing.
+ Gets the last_uri of this DncListDivisionViewListing.
- :return: The first_uri of this DncListDivisionViewListing.
+ :return: The last_uri of this DncListDivisionViewListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DncListDivisionViewListing.
+ Sets the last_uri of this DncListDivisionViewListing.
- :param first_uri: The first_uri of this DncListDivisionViewListing.
+ :param last_uri: The last_uri of this DncListDivisionViewListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/dnc_list_entity_listing.py b/build/PureCloudPlatformClientV2/models/dnc_list_entity_listing.py
index d93f1b32f..0200650e0 100644
--- a/build/PureCloudPlatformClientV2/models/dnc_list_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/dnc_list_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DncListEntityListing.
+ Gets the first_uri of this DncListEntityListing.
- :return: The last_uri of this DncListEntityListing.
+ :return: The first_uri of this DncListEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DncListEntityListing.
+ Sets the first_uri of this DncListEntityListing.
- :param last_uri: The last_uri of this DncListEntityListing.
+ :param first_uri: The first_uri of this DncListEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DncListEntityListing.
+ Gets the last_uri of this DncListEntityListing.
- :return: The first_uri of this DncListEntityListing.
+ :return: The last_uri of this DncListEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DncListEntityListing.
+ Sets the last_uri of this DncListEntityListing.
- :param first_uri: The first_uri of this DncListEntityListing.
+ :param last_uri: The last_uri of this DncListEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/document_entity_listing.py b/build/PureCloudPlatformClientV2/models/document_entity_listing.py
index ccdc515d0..6531ee3af 100644
--- a/build/PureCloudPlatformClientV2/models/document_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/document_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DocumentEntityListing.
+ Gets the first_uri of this DocumentEntityListing.
- :return: The last_uri of this DocumentEntityListing.
+ :return: The first_uri of this DocumentEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DocumentEntityListing.
+ Sets the first_uri of this DocumentEntityListing.
- :param last_uri: The last_uri of this DocumentEntityListing.
+ :param first_uri: The first_uri of this DocumentEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DocumentEntityListing.
+ Gets the last_uri of this DocumentEntityListing.
- :return: The first_uri of this DocumentEntityListing.
+ :return: The last_uri of this DocumentEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DocumentEntityListing.
+ Sets the last_uri of this DocumentEntityListing.
- :param first_uri: The first_uri of this DocumentEntityListing.
+ :param last_uri: The last_uri of this DocumentEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/domain_edge_software_version_dto_entity_listing.py b/build/PureCloudPlatformClientV2/models/domain_edge_software_version_dto_entity_listing.py
index a03677bf6..4878a1c33 100644
--- a/build/PureCloudPlatformClientV2/models/domain_edge_software_version_dto_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/domain_edge_software_version_dto_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DomainEdgeSoftwareVersionDtoEntityListing.
+ Gets the first_uri of this DomainEdgeSoftwareVersionDtoEntityListing.
- :return: The last_uri of this DomainEdgeSoftwareVersionDtoEntityListing.
+ :return: The first_uri of this DomainEdgeSoftwareVersionDtoEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DomainEdgeSoftwareVersionDtoEntityListing.
+ Sets the first_uri of this DomainEdgeSoftwareVersionDtoEntityListing.
- :param last_uri: The last_uri of this DomainEdgeSoftwareVersionDtoEntityListing.
+ :param first_uri: The first_uri of this DomainEdgeSoftwareVersionDtoEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DomainEdgeSoftwareVersionDtoEntityListing.
+ Gets the last_uri of this DomainEdgeSoftwareVersionDtoEntityListing.
- :return: The first_uri of this DomainEdgeSoftwareVersionDtoEntityListing.
+ :return: The last_uri of this DomainEdgeSoftwareVersionDtoEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DomainEdgeSoftwareVersionDtoEntityListing.
+ Sets the last_uri of this DomainEdgeSoftwareVersionDtoEntityListing.
- :param first_uri: The first_uri of this DomainEdgeSoftwareVersionDtoEntityListing.
+ :param last_uri: The last_uri of this DomainEdgeSoftwareVersionDtoEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/domain_entity_listing.py b/build/PureCloudPlatformClientV2/models/domain_entity_listing.py
index 60ff3078e..545b4c4d9 100644
--- a/build/PureCloudPlatformClientV2/models/domain_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/domain_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DomainEntityListing.
+ Gets the first_uri of this DomainEntityListing.
- :return: The last_uri of this DomainEntityListing.
+ :return: The first_uri of this DomainEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DomainEntityListing.
+ Sets the first_uri of this DomainEntityListing.
- :param last_uri: The last_uri of this DomainEntityListing.
+ :param first_uri: The first_uri of this DomainEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DomainEntityListing.
+ Gets the last_uri of this DomainEntityListing.
- :return: The first_uri of this DomainEntityListing.
+ :return: The last_uri of this DomainEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DomainEntityListing.
+ Sets the last_uri of this DomainEntityListing.
- :param first_uri: The first_uri of this DomainEntityListing.
+ :param last_uri: The last_uri of this DomainEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/domain_entity_listing_evaluation_form.py b/build/PureCloudPlatformClientV2/models/domain_entity_listing_evaluation_form.py
index ff5ee34df..eca21435f 100644
--- a/build/PureCloudPlatformClientV2/models/domain_entity_listing_evaluation_form.py
+++ b/build/PureCloudPlatformClientV2/models/domain_entity_listing_evaluation_form.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DomainEntityListingEvaluationForm.
+ Gets the first_uri of this DomainEntityListingEvaluationForm.
- :return: The last_uri of this DomainEntityListingEvaluationForm.
+ :return: The first_uri of this DomainEntityListingEvaluationForm.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DomainEntityListingEvaluationForm.
+ Sets the first_uri of this DomainEntityListingEvaluationForm.
- :param last_uri: The last_uri of this DomainEntityListingEvaluationForm.
+ :param first_uri: The first_uri of this DomainEntityListingEvaluationForm.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DomainEntityListingEvaluationForm.
+ Gets the last_uri of this DomainEntityListingEvaluationForm.
- :return: The first_uri of this DomainEntityListingEvaluationForm.
+ :return: The last_uri of this DomainEntityListingEvaluationForm.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DomainEntityListingEvaluationForm.
+ Sets the last_uri of this DomainEntityListingEvaluationForm.
- :param first_uri: The first_uri of this DomainEntityListingEvaluationForm.
+ :param last_uri: The last_uri of this DomainEntityListingEvaluationForm.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/domain_entity_listing_query_result.py b/build/PureCloudPlatformClientV2/models/domain_entity_listing_query_result.py
index 70abd3fac..2d072e0fd 100644
--- a/build/PureCloudPlatformClientV2/models/domain_entity_listing_query_result.py
+++ b/build/PureCloudPlatformClientV2/models/domain_entity_listing_query_result.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DomainEntityListingQueryResult.
+ Gets the first_uri of this DomainEntityListingQueryResult.
- :return: The last_uri of this DomainEntityListingQueryResult.
+ :return: The first_uri of this DomainEntityListingQueryResult.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DomainEntityListingQueryResult.
+ Sets the first_uri of this DomainEntityListingQueryResult.
- :param last_uri: The last_uri of this DomainEntityListingQueryResult.
+ :param first_uri: The first_uri of this DomainEntityListingQueryResult.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DomainEntityListingQueryResult.
+ Gets the last_uri of this DomainEntityListingQueryResult.
- :return: The first_uri of this DomainEntityListingQueryResult.
+ :return: The last_uri of this DomainEntityListingQueryResult.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DomainEntityListingQueryResult.
+ Sets the last_uri of this DomainEntityListingQueryResult.
- :param first_uri: The first_uri of this DomainEntityListingQueryResult.
+ :param last_uri: The last_uri of this DomainEntityListingQueryResult.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/domain_entity_listing_survey_form.py b/build/PureCloudPlatformClientV2/models/domain_entity_listing_survey_form.py
index 0877bcbea..77991ff25 100644
--- a/build/PureCloudPlatformClientV2/models/domain_entity_listing_survey_form.py
+++ b/build/PureCloudPlatformClientV2/models/domain_entity_listing_survey_form.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this DomainEntityListingSurveyForm.
+ Gets the first_uri of this DomainEntityListingSurveyForm.
- :return: The last_uri of this DomainEntityListingSurveyForm.
+ :return: The first_uri of this DomainEntityListingSurveyForm.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this DomainEntityListingSurveyForm.
+ Sets the first_uri of this DomainEntityListingSurveyForm.
- :param last_uri: The last_uri of this DomainEntityListingSurveyForm.
+ :param first_uri: The first_uri of this DomainEntityListingSurveyForm.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this DomainEntityListingSurveyForm.
+ Gets the last_uri of this DomainEntityListingSurveyForm.
- :return: The first_uri of this DomainEntityListingSurveyForm.
+ :return: The last_uri of this DomainEntityListingSurveyForm.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this DomainEntityListingSurveyForm.
+ Sets the last_uri of this DomainEntityListingSurveyForm.
- :param first_uri: The first_uri of this DomainEntityListingSurveyForm.
+ :param last_uri: The last_uri of this DomainEntityListingSurveyForm.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/edge_entity_listing.py b/build/PureCloudPlatformClientV2/models/edge_entity_listing.py
index 4c352c3d7..811319dd9 100644
--- a/build/PureCloudPlatformClientV2/models/edge_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/edge_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this EdgeEntityListing.
+ Gets the first_uri of this EdgeEntityListing.
- :return: The last_uri of this EdgeEntityListing.
+ :return: The first_uri of this EdgeEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this EdgeEntityListing.
+ Sets the first_uri of this EdgeEntityListing.
- :param last_uri: The last_uri of this EdgeEntityListing.
+ :param first_uri: The first_uri of this EdgeEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this EdgeEntityListing.
+ Gets the last_uri of this EdgeEntityListing.
- :return: The first_uri of this EdgeEntityListing.
+ :return: The last_uri of this EdgeEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this EdgeEntityListing.
+ Sets the last_uri of this EdgeEntityListing.
- :param first_uri: The first_uri of this EdgeEntityListing.
+ :param last_uri: The last_uri of this EdgeEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/edge_group_entity_listing.py b/build/PureCloudPlatformClientV2/models/edge_group_entity_listing.py
index 6aa1174da..a21c5c4d0 100644
--- a/build/PureCloudPlatformClientV2/models/edge_group_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/edge_group_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this EdgeGroupEntityListing.
+ Gets the first_uri of this EdgeGroupEntityListing.
- :return: The last_uri of this EdgeGroupEntityListing.
+ :return: The first_uri of this EdgeGroupEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this EdgeGroupEntityListing.
+ Sets the first_uri of this EdgeGroupEntityListing.
- :param last_uri: The last_uri of this EdgeGroupEntityListing.
+ :param first_uri: The first_uri of this EdgeGroupEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this EdgeGroupEntityListing.
+ Gets the last_uri of this EdgeGroupEntityListing.
- :return: The first_uri of this EdgeGroupEntityListing.
+ :return: The last_uri of this EdgeGroupEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this EdgeGroupEntityListing.
+ Sets the last_uri of this EdgeGroupEntityListing.
- :param first_uri: The first_uri of this EdgeGroupEntityListing.
+ :param last_uri: The last_uri of this EdgeGroupEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/email_campaign_schedule_entity_listing.py b/build/PureCloudPlatformClientV2/models/email_campaign_schedule_entity_listing.py
index f380fcc47..e416b4990 100644
--- a/build/PureCloudPlatformClientV2/models/email_campaign_schedule_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/email_campaign_schedule_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this EmailCampaignScheduleEntityListing.
+ Gets the first_uri of this EmailCampaignScheduleEntityListing.
- :return: The last_uri of this EmailCampaignScheduleEntityListing.
+ :return: The first_uri of this EmailCampaignScheduleEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this EmailCampaignScheduleEntityListing.
+ Sets the first_uri of this EmailCampaignScheduleEntityListing.
- :param last_uri: The last_uri of this EmailCampaignScheduleEntityListing.
+ :param first_uri: The first_uri of this EmailCampaignScheduleEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this EmailCampaignScheduleEntityListing.
+ Gets the last_uri of this EmailCampaignScheduleEntityListing.
- :return: The first_uri of this EmailCampaignScheduleEntityListing.
+ :return: The last_uri of this EmailCampaignScheduleEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this EmailCampaignScheduleEntityListing.
+ Sets the last_uri of this EmailCampaignScheduleEntityListing.
- :param first_uri: The first_uri of this EmailCampaignScheduleEntityListing.
+ :param last_uri: The last_uri of this EmailCampaignScheduleEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/email_conversation_entity_listing.py b/build/PureCloudPlatformClientV2/models/email_conversation_entity_listing.py
index 633a6a66f..7107a8f66 100644
--- a/build/PureCloudPlatformClientV2/models/email_conversation_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/email_conversation_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this EmailConversationEntityListing.
+ Gets the first_uri of this EmailConversationEntityListing.
- :return: The last_uri of this EmailConversationEntityListing.
+ :return: The first_uri of this EmailConversationEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this EmailConversationEntityListing.
+ Sets the first_uri of this EmailConversationEntityListing.
- :param last_uri: The last_uri of this EmailConversationEntityListing.
+ :param first_uri: The first_uri of this EmailConversationEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this EmailConversationEntityListing.
+ Gets the last_uri of this EmailConversationEntityListing.
- :return: The first_uri of this EmailConversationEntityListing.
+ :return: The last_uri of this EmailConversationEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this EmailConversationEntityListing.
+ Sets the last_uri of this EmailConversationEntityListing.
- :param first_uri: The first_uri of this EmailConversationEntityListing.
+ :param last_uri: The last_uri of this EmailConversationEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/email_message_preview_listing.py b/build/PureCloudPlatformClientV2/models/email_message_preview_listing.py
index 5e8fa2fdd..05f35f8c2 100644
--- a/build/PureCloudPlatformClientV2/models/email_message_preview_listing.py
+++ b/build/PureCloudPlatformClientV2/models/email_message_preview_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this EmailMessagePreviewListing.
+ Gets the first_uri of this EmailMessagePreviewListing.
- :return: The last_uri of this EmailMessagePreviewListing.
+ :return: The first_uri of this EmailMessagePreviewListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this EmailMessagePreviewListing.
+ Sets the first_uri of this EmailMessagePreviewListing.
- :param last_uri: The last_uri of this EmailMessagePreviewListing.
+ :param first_uri: The first_uri of this EmailMessagePreviewListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this EmailMessagePreviewListing.
+ Gets the last_uri of this EmailMessagePreviewListing.
- :return: The first_uri of this EmailMessagePreviewListing.
+ :return: The last_uri of this EmailMessagePreviewListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this EmailMessagePreviewListing.
+ Sets the last_uri of this EmailMessagePreviewListing.
- :param first_uri: The first_uri of this EmailMessagePreviewListing.
+ :param last_uri: The last_uri of this EmailMessagePreviewListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/emergency_group_division_view_entity_listing.py b/build/PureCloudPlatformClientV2/models/emergency_group_division_view_entity_listing.py
index 3d72f5545..695372fab 100644
--- a/build/PureCloudPlatformClientV2/models/emergency_group_division_view_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/emergency_group_division_view_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this EmergencyGroupDivisionViewEntityListing.
+ Gets the first_uri of this EmergencyGroupDivisionViewEntityListing.
- :return: The last_uri of this EmergencyGroupDivisionViewEntityListing.
+ :return: The first_uri of this EmergencyGroupDivisionViewEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this EmergencyGroupDivisionViewEntityListing.
+ Sets the first_uri of this EmergencyGroupDivisionViewEntityListing.
- :param last_uri: The last_uri of this EmergencyGroupDivisionViewEntityListing.
+ :param first_uri: The first_uri of this EmergencyGroupDivisionViewEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this EmergencyGroupDivisionViewEntityListing.
+ Gets the last_uri of this EmergencyGroupDivisionViewEntityListing.
- :return: The first_uri of this EmergencyGroupDivisionViewEntityListing.
+ :return: The last_uri of this EmergencyGroupDivisionViewEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this EmergencyGroupDivisionViewEntityListing.
+ Sets the last_uri of this EmergencyGroupDivisionViewEntityListing.
- :param first_uri: The first_uri of this EmergencyGroupDivisionViewEntityListing.
+ :param last_uri: The last_uri of this EmergencyGroupDivisionViewEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/emergency_group_listing.py b/build/PureCloudPlatformClientV2/models/emergency_group_listing.py
index 24de768fb..7012d1ac0 100644
--- a/build/PureCloudPlatformClientV2/models/emergency_group_listing.py
+++ b/build/PureCloudPlatformClientV2/models/emergency_group_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this EmergencyGroupListing.
+ Gets the first_uri of this EmergencyGroupListing.
- :return: The last_uri of this EmergencyGroupListing.
+ :return: The first_uri of this EmergencyGroupListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this EmergencyGroupListing.
+ Sets the first_uri of this EmergencyGroupListing.
- :param last_uri: The last_uri of this EmergencyGroupListing.
+ :param first_uri: The first_uri of this EmergencyGroupListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this EmergencyGroupListing.
+ Gets the last_uri of this EmergencyGroupListing.
- :return: The first_uri of this EmergencyGroupListing.
+ :return: The last_uri of this EmergencyGroupListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this EmergencyGroupListing.
+ Sets the last_uri of this EmergencyGroupListing.
- :param first_uri: The first_uri of this EmergencyGroupListing.
+ :param last_uri: The last_uri of this EmergencyGroupListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/encryption_key_entity_listing.py b/build/PureCloudPlatformClientV2/models/encryption_key_entity_listing.py
index 72840413b..e63ad0a12 100644
--- a/build/PureCloudPlatformClientV2/models/encryption_key_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/encryption_key_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this EncryptionKeyEntityListing.
+ Gets the first_uri of this EncryptionKeyEntityListing.
- :return: The last_uri of this EncryptionKeyEntityListing.
+ :return: The first_uri of this EncryptionKeyEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this EncryptionKeyEntityListing.
+ Sets the first_uri of this EncryptionKeyEntityListing.
- :param last_uri: The last_uri of this EncryptionKeyEntityListing.
+ :param first_uri: The first_uri of this EncryptionKeyEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this EncryptionKeyEntityListing.
+ Gets the last_uri of this EncryptionKeyEntityListing.
- :return: The first_uri of this EncryptionKeyEntityListing.
+ :return: The last_uri of this EncryptionKeyEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this EncryptionKeyEntityListing.
+ Sets the last_uri of this EncryptionKeyEntityListing.
- :param first_uri: The first_uri of this EncryptionKeyEntityListing.
+ :param last_uri: The last_uri of this EncryptionKeyEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/evaluation_entity_listing.py b/build/PureCloudPlatformClientV2/models/evaluation_entity_listing.py
index 4fa9a0ea1..1a0ed2d04 100644
--- a/build/PureCloudPlatformClientV2/models/evaluation_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/evaluation_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this EvaluationEntityListing.
+ Gets the first_uri of this EvaluationEntityListing.
- :return: The last_uri of this EvaluationEntityListing.
+ :return: The first_uri of this EvaluationEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this EvaluationEntityListing.
+ Sets the first_uri of this EvaluationEntityListing.
- :param last_uri: The last_uri of this EvaluationEntityListing.
+ :param first_uri: The first_uri of this EvaluationEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this EvaluationEntityListing.
+ Gets the last_uri of this EvaluationEntityListing.
- :return: The first_uri of this EvaluationEntityListing.
+ :return: The last_uri of this EvaluationEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this EvaluationEntityListing.
+ Sets the last_uri of this EvaluationEntityListing.
- :param first_uri: The first_uri of this EvaluationEntityListing.
+ :param last_uri: The last_uri of this EvaluationEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/evaluation_form_response_entity_listing.py b/build/PureCloudPlatformClientV2/models/evaluation_form_response_entity_listing.py
index d03ffa13d..4a92a61f0 100644
--- a/build/PureCloudPlatformClientV2/models/evaluation_form_response_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/evaluation_form_response_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this EvaluationFormResponseEntityListing.
+ Gets the first_uri of this EvaluationFormResponseEntityListing.
- :return: The last_uri of this EvaluationFormResponseEntityListing.
+ :return: The first_uri of this EvaluationFormResponseEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this EvaluationFormResponseEntityListing.
+ Sets the first_uri of this EvaluationFormResponseEntityListing.
- :param last_uri: The last_uri of this EvaluationFormResponseEntityListing.
+ :param first_uri: The first_uri of this EvaluationFormResponseEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this EvaluationFormResponseEntityListing.
+ Gets the last_uri of this EvaluationFormResponseEntityListing.
- :return: The first_uri of this EvaluationFormResponseEntityListing.
+ :return: The last_uri of this EvaluationFormResponseEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this EvaluationFormResponseEntityListing.
+ Sets the last_uri of this EvaluationFormResponseEntityListing.
- :param first_uri: The first_uri of this EvaluationFormResponseEntityListing.
+ :param last_uri: The last_uri of this EvaluationFormResponseEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/evaluator_activity_entity_listing.py b/build/PureCloudPlatformClientV2/models/evaluator_activity_entity_listing.py
index 1658d7184..0f685248e 100644
--- a/build/PureCloudPlatformClientV2/models/evaluator_activity_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/evaluator_activity_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this EvaluatorActivityEntityListing.
+ Gets the first_uri of this EvaluatorActivityEntityListing.
- :return: The last_uri of this EvaluatorActivityEntityListing.
+ :return: The first_uri of this EvaluatorActivityEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this EvaluatorActivityEntityListing.
+ Sets the first_uri of this EvaluatorActivityEntityListing.
- :param last_uri: The last_uri of this EvaluatorActivityEntityListing.
+ :param first_uri: The first_uri of this EvaluatorActivityEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this EvaluatorActivityEntityListing.
+ Gets the last_uri of this EvaluatorActivityEntityListing.
- :return: The first_uri of this EvaluatorActivityEntityListing.
+ :return: The last_uri of this EvaluatorActivityEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this EvaluatorActivityEntityListing.
+ Sets the last_uri of this EvaluatorActivityEntityListing.
- :param first_uri: The first_uri of this EvaluatorActivityEntityListing.
+ :param last_uri: The last_uri of this EvaluatorActivityEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/extension_entity_listing.py b/build/PureCloudPlatformClientV2/models/extension_entity_listing.py
index 46da66c77..557c10d2f 100644
--- a/build/PureCloudPlatformClientV2/models/extension_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/extension_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ExtensionEntityListing.
+ Gets the first_uri of this ExtensionEntityListing.
- :return: The last_uri of this ExtensionEntityListing.
+ :return: The first_uri of this ExtensionEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ExtensionEntityListing.
+ Sets the first_uri of this ExtensionEntityListing.
- :param last_uri: The last_uri of this ExtensionEntityListing.
+ :param first_uri: The first_uri of this ExtensionEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ExtensionEntityListing.
+ Gets the last_uri of this ExtensionEntityListing.
- :return: The first_uri of this ExtensionEntityListing.
+ :return: The last_uri of this ExtensionEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ExtensionEntityListing.
+ Sets the last_uri of this ExtensionEntityListing.
- :param first_uri: The first_uri of this ExtensionEntityListing.
+ :param last_uri: The last_uri of this ExtensionEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/extension_pool_division_view_entity_listing.py b/build/PureCloudPlatformClientV2/models/extension_pool_division_view_entity_listing.py
index 7f0813dd8..63d2b1076 100644
--- a/build/PureCloudPlatformClientV2/models/extension_pool_division_view_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/extension_pool_division_view_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ExtensionPoolDivisionViewEntityListing.
+ Gets the first_uri of this ExtensionPoolDivisionViewEntityListing.
- :return: The last_uri of this ExtensionPoolDivisionViewEntityListing.
+ :return: The first_uri of this ExtensionPoolDivisionViewEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ExtensionPoolDivisionViewEntityListing.
+ Sets the first_uri of this ExtensionPoolDivisionViewEntityListing.
- :param last_uri: The last_uri of this ExtensionPoolDivisionViewEntityListing.
+ :param first_uri: The first_uri of this ExtensionPoolDivisionViewEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ExtensionPoolDivisionViewEntityListing.
+ Gets the last_uri of this ExtensionPoolDivisionViewEntityListing.
- :return: The first_uri of this ExtensionPoolDivisionViewEntityListing.
+ :return: The last_uri of this ExtensionPoolDivisionViewEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ExtensionPoolDivisionViewEntityListing.
+ Sets the last_uri of this ExtensionPoolDivisionViewEntityListing.
- :param first_uri: The first_uri of this ExtensionPoolDivisionViewEntityListing.
+ :param last_uri: The last_uri of this ExtensionPoolDivisionViewEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/extension_pool_entity_listing.py b/build/PureCloudPlatformClientV2/models/extension_pool_entity_listing.py
index feeb1ce54..62d9d900c 100644
--- a/build/PureCloudPlatformClientV2/models/extension_pool_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/extension_pool_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ExtensionPoolEntityListing.
+ Gets the first_uri of this ExtensionPoolEntityListing.
- :return: The last_uri of this ExtensionPoolEntityListing.
+ :return: The first_uri of this ExtensionPoolEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ExtensionPoolEntityListing.
+ Sets the first_uri of this ExtensionPoolEntityListing.
- :param last_uri: The last_uri of this ExtensionPoolEntityListing.
+ :param first_uri: The first_uri of this ExtensionPoolEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ExtensionPoolEntityListing.
+ Gets the last_uri of this ExtensionPoolEntityListing.
- :return: The first_uri of this ExtensionPoolEntityListing.
+ :return: The last_uri of this ExtensionPoolEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ExtensionPoolEntityListing.
+ Sets the last_uri of this ExtensionPoolEntityListing.
- :param first_uri: The first_uri of this ExtensionPoolEntityListing.
+ :param last_uri: The last_uri of this ExtensionPoolEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/external_metric_definition_listing.py b/build/PureCloudPlatformClientV2/models/external_metric_definition_listing.py
index c9b8f67d3..92c8b0bf2 100644
--- a/build/PureCloudPlatformClientV2/models/external_metric_definition_listing.py
+++ b/build/PureCloudPlatformClientV2/models/external_metric_definition_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ExternalMetricDefinitionListing.
+ Gets the first_uri of this ExternalMetricDefinitionListing.
- :return: The last_uri of this ExternalMetricDefinitionListing.
+ :return: The first_uri of this ExternalMetricDefinitionListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ExternalMetricDefinitionListing.
+ Sets the first_uri of this ExternalMetricDefinitionListing.
- :param last_uri: The last_uri of this ExternalMetricDefinitionListing.
+ :param first_uri: The first_uri of this ExternalMetricDefinitionListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ExternalMetricDefinitionListing.
+ Gets the last_uri of this ExternalMetricDefinitionListing.
- :return: The first_uri of this ExternalMetricDefinitionListing.
+ :return: The last_uri of this ExternalMetricDefinitionListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ExternalMetricDefinitionListing.
+ Sets the last_uri of this ExternalMetricDefinitionListing.
- :param first_uri: The first_uri of this ExternalMetricDefinitionListing.
+ :param last_uri: The last_uri of this ExternalMetricDefinitionListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/external_organization_listing.py b/build/PureCloudPlatformClientV2/models/external_organization_listing.py
index 7b0dffdf2..35911e69c 100644
--- a/build/PureCloudPlatformClientV2/models/external_organization_listing.py
+++ b/build/PureCloudPlatformClientV2/models/external_organization_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'partial_results': 'bool',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'partial_results': 'partialResults',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._partial_results = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def partial_results(self, partial_results: bool) -> None:
self._partial_results = partial_results
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ExternalOrganizationListing.
+ Gets the first_uri of this ExternalOrganizationListing.
- :return: The last_uri of this ExternalOrganizationListing.
+ :return: The first_uri of this ExternalOrganizationListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ExternalOrganizationListing.
+ Sets the first_uri of this ExternalOrganizationListing.
- :param last_uri: The last_uri of this ExternalOrganizationListing.
+ :param first_uri: The first_uri of this ExternalOrganizationListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ExternalOrganizationListing.
+ Gets the last_uri of this ExternalOrganizationListing.
- :return: The first_uri of this ExternalOrganizationListing.
+ :return: The last_uri of this ExternalOrganizationListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ExternalOrganizationListing.
+ Sets the last_uri of this ExternalOrganizationListing.
- :param first_uri: The first_uri of this ExternalOrganizationListing.
+ :param last_uri: The last_uri of this ExternalOrganizationListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/facebook_integration_entity_listing.py b/build/PureCloudPlatformClientV2/models/facebook_integration_entity_listing.py
index 1a7dd7011..90ce8acff 100644
--- a/build/PureCloudPlatformClientV2/models/facebook_integration_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/facebook_integration_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this FacebookIntegrationEntityListing.
+ Gets the first_uri of this FacebookIntegrationEntityListing.
- :return: The last_uri of this FacebookIntegrationEntityListing.
+ :return: The first_uri of this FacebookIntegrationEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this FacebookIntegrationEntityListing.
+ Sets the first_uri of this FacebookIntegrationEntityListing.
- :param last_uri: The last_uri of this FacebookIntegrationEntityListing.
+ :param first_uri: The first_uri of this FacebookIntegrationEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this FacebookIntegrationEntityListing.
+ Gets the last_uri of this FacebookIntegrationEntityListing.
- :return: The first_uri of this FacebookIntegrationEntityListing.
+ :return: The last_uri of this FacebookIntegrationEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this FacebookIntegrationEntityListing.
+ Sets the last_uri of this FacebookIntegrationEntityListing.
- :param first_uri: The first_uri of this FacebookIntegrationEntityListing.
+ :param last_uri: The last_uri of this FacebookIntegrationEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/failed_recording_entity_listing.py b/build/PureCloudPlatformClientV2/models/failed_recording_entity_listing.py
index 56eaaca01..39a2e9ed6 100644
--- a/build/PureCloudPlatformClientV2/models/failed_recording_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/failed_recording_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this FailedRecordingEntityListing.
+ Gets the first_uri of this FailedRecordingEntityListing.
- :return: The last_uri of this FailedRecordingEntityListing.
+ :return: The first_uri of this FailedRecordingEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this FailedRecordingEntityListing.
+ Sets the first_uri of this FailedRecordingEntityListing.
- :param last_uri: The last_uri of this FailedRecordingEntityListing.
+ :param first_uri: The first_uri of this FailedRecordingEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this FailedRecordingEntityListing.
+ Gets the last_uri of this FailedRecordingEntityListing.
- :return: The first_uri of this FailedRecordingEntityListing.
+ :return: The last_uri of this FailedRecordingEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this FailedRecordingEntityListing.
+ Sets the last_uri of this FailedRecordingEntityListing.
- :param first_uri: The first_uri of this FailedRecordingEntityListing.
+ :param last_uri: The last_uri of this FailedRecordingEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/fallback.py b/build/PureCloudPlatformClientV2/models/fallback.py
new file mode 100644
index 000000000..f8e33c809
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/fallback.py
@@ -0,0 +1,168 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import CopilotFallbackAction
+
+class Fallback(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ Fallback - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'enabled': 'bool',
+ 'actions': 'list[CopilotFallbackAction]'
+ }
+
+ self.attribute_map = {
+ 'enabled': 'enabled',
+ 'actions': 'actions'
+ }
+
+ self._enabled = None
+ self._actions = None
+
+ @property
+ def enabled(self) -> bool:
+ """
+ Gets the enabled of this Fallback.
+ Fallback actions are enabled.
+
+ :return: The enabled of this Fallback.
+ :rtype: bool
+ """
+ return self._enabled
+
+ @enabled.setter
+ def enabled(self, enabled: bool) -> None:
+ """
+ Sets the enabled of this Fallback.
+ Fallback actions are enabled.
+
+ :param enabled: The enabled of this Fallback.
+ :type: bool
+ """
+
+
+ self._enabled = enabled
+
+ @property
+ def actions(self) -> List['CopilotFallbackAction']:
+ """
+ Gets the actions of this Fallback.
+ Fallback actions.
+
+ :return: The actions of this Fallback.
+ :rtype: list[CopilotFallbackAction]
+ """
+ return self._actions
+
+ @actions.setter
+ def actions(self, actions: List['CopilotFallbackAction']) -> None:
+ """
+ Sets the actions of this Fallback.
+ Fallback actions.
+
+ :param actions: The actions of this Fallback.
+ :type: list[CopilotFallbackAction]
+ """
+
+
+ self._actions = actions
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/fax_document_entity_listing.py b/build/PureCloudPlatformClientV2/models/fax_document_entity_listing.py
index 168761199..2d749fc14 100644
--- a/build/PureCloudPlatformClientV2/models/fax_document_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/fax_document_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this FaxDocumentEntityListing.
+ Gets the first_uri of this FaxDocumentEntityListing.
- :return: The last_uri of this FaxDocumentEntityListing.
+ :return: The first_uri of this FaxDocumentEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this FaxDocumentEntityListing.
+ Sets the first_uri of this FaxDocumentEntityListing.
- :param last_uri: The last_uri of this FaxDocumentEntityListing.
+ :param first_uri: The first_uri of this FaxDocumentEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this FaxDocumentEntityListing.
+ Gets the last_uri of this FaxDocumentEntityListing.
- :return: The first_uri of this FaxDocumentEntityListing.
+ :return: The last_uri of this FaxDocumentEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this FaxDocumentEntityListing.
+ Sets the last_uri of this FaxDocumentEntityListing.
- :param first_uri: The first_uri of this FaxDocumentEntityListing.
+ :param last_uri: The last_uri of this FaxDocumentEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/file_specification_template_entity_listing.py b/build/PureCloudPlatformClientV2/models/file_specification_template_entity_listing.py
index 988e4f022..c1bb81e04 100644
--- a/build/PureCloudPlatformClientV2/models/file_specification_template_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/file_specification_template_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this FileSpecificationTemplateEntityListing.
+ Gets the first_uri of this FileSpecificationTemplateEntityListing.
- :return: The last_uri of this FileSpecificationTemplateEntityListing.
+ :return: The first_uri of this FileSpecificationTemplateEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this FileSpecificationTemplateEntityListing.
+ Sets the first_uri of this FileSpecificationTemplateEntityListing.
- :param last_uri: The last_uri of this FileSpecificationTemplateEntityListing.
+ :param first_uri: The first_uri of this FileSpecificationTemplateEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this FileSpecificationTemplateEntityListing.
+ Gets the last_uri of this FileSpecificationTemplateEntityListing.
- :return: The first_uri of this FileSpecificationTemplateEntityListing.
+ :return: The last_uri of this FileSpecificationTemplateEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this FileSpecificationTemplateEntityListing.
+ Sets the last_uri of this FileSpecificationTemplateEntityListing.
- :param first_uri: The first_uri of this FileSpecificationTemplateEntityListing.
+ :param last_uri: The last_uri of this FileSpecificationTemplateEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/flow_division_view_entity_listing.py b/build/PureCloudPlatformClientV2/models/flow_division_view_entity_listing.py
index 8ad014b1a..31452e1a1 100644
--- a/build/PureCloudPlatformClientV2/models/flow_division_view_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/flow_division_view_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this FlowDivisionViewEntityListing.
+ Gets the first_uri of this FlowDivisionViewEntityListing.
- :return: The last_uri of this FlowDivisionViewEntityListing.
+ :return: The first_uri of this FlowDivisionViewEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this FlowDivisionViewEntityListing.
+ Sets the first_uri of this FlowDivisionViewEntityListing.
- :param last_uri: The last_uri of this FlowDivisionViewEntityListing.
+ :param first_uri: The first_uri of this FlowDivisionViewEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this FlowDivisionViewEntityListing.
+ Gets the last_uri of this FlowDivisionViewEntityListing.
- :return: The first_uri of this FlowDivisionViewEntityListing.
+ :return: The last_uri of this FlowDivisionViewEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this FlowDivisionViewEntityListing.
+ Sets the last_uri of this FlowDivisionViewEntityListing.
- :param first_uri: The first_uri of this FlowDivisionViewEntityListing.
+ :param last_uri: The last_uri of this FlowDivisionViewEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/flow_end_detail_event_topic_flow_end_event.py b/build/PureCloudPlatformClientV2/models/flow_end_detail_event_topic_flow_end_event.py
index a9db23930..587f115e6 100644
--- a/build/PureCloudPlatformClientV2/models/flow_end_detail_event_topic_flow_end_event.py
+++ b/build/PureCloudPlatformClientV2/models/flow_end_detail_event_topic_flow_end_event.py
@@ -472,7 +472,7 @@ def message_type(self, message_type: str) -> None:
"""
if isinstance(message_type, int):
message_type = str(message_type)
- allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM"]
+ allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM", "APPLE"]
if message_type.lower() not in map(str.lower, allowed_values):
# print("Invalid value for message_type -> " + message_type)
self._message_type = "outdated_sdk_version"
diff --git a/build/PureCloudPlatformClientV2/models/flow_entity_listing.py b/build/PureCloudPlatformClientV2/models/flow_entity_listing.py
index af724e593..4b5711dc2 100644
--- a/build/PureCloudPlatformClientV2/models/flow_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/flow_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this FlowEntityListing.
+ Gets the first_uri of this FlowEntityListing.
- :return: The last_uri of this FlowEntityListing.
+ :return: The first_uri of this FlowEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this FlowEntityListing.
+ Sets the first_uri of this FlowEntityListing.
- :param last_uri: The last_uri of this FlowEntityListing.
+ :param first_uri: The first_uri of this FlowEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this FlowEntityListing.
+ Gets the last_uri of this FlowEntityListing.
- :return: The first_uri of this FlowEntityListing.
+ :return: The last_uri of this FlowEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this FlowEntityListing.
+ Sets the last_uri of this FlowEntityListing.
- :param first_uri: The first_uri of this FlowEntityListing.
+ :param last_uri: The last_uri of this FlowEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/flow_milestone_division_view_entity_listing.py b/build/PureCloudPlatformClientV2/models/flow_milestone_division_view_entity_listing.py
index 4ccf31350..16dd0a858 100644
--- a/build/PureCloudPlatformClientV2/models/flow_milestone_division_view_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/flow_milestone_division_view_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this FlowMilestoneDivisionViewEntityListing.
+ Gets the first_uri of this FlowMilestoneDivisionViewEntityListing.
- :return: The last_uri of this FlowMilestoneDivisionViewEntityListing.
+ :return: The first_uri of this FlowMilestoneDivisionViewEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this FlowMilestoneDivisionViewEntityListing.
+ Sets the first_uri of this FlowMilestoneDivisionViewEntityListing.
- :param last_uri: The last_uri of this FlowMilestoneDivisionViewEntityListing.
+ :param first_uri: The first_uri of this FlowMilestoneDivisionViewEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this FlowMilestoneDivisionViewEntityListing.
+ Gets the last_uri of this FlowMilestoneDivisionViewEntityListing.
- :return: The first_uri of this FlowMilestoneDivisionViewEntityListing.
+ :return: The last_uri of this FlowMilestoneDivisionViewEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this FlowMilestoneDivisionViewEntityListing.
+ Sets the last_uri of this FlowMilestoneDivisionViewEntityListing.
- :param first_uri: The first_uri of this FlowMilestoneDivisionViewEntityListing.
+ :param last_uri: The last_uri of this FlowMilestoneDivisionViewEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/flow_milestone_listing.py b/build/PureCloudPlatformClientV2/models/flow_milestone_listing.py
index 33f788507..aaddf7cfa 100644
--- a/build/PureCloudPlatformClientV2/models/flow_milestone_listing.py
+++ b/build/PureCloudPlatformClientV2/models/flow_milestone_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this FlowMilestoneListing.
+ Gets the first_uri of this FlowMilestoneListing.
- :return: The last_uri of this FlowMilestoneListing.
+ :return: The first_uri of this FlowMilestoneListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this FlowMilestoneListing.
+ Sets the first_uri of this FlowMilestoneListing.
- :param last_uri: The last_uri of this FlowMilestoneListing.
+ :param first_uri: The first_uri of this FlowMilestoneListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this FlowMilestoneListing.
+ Gets the last_uri of this FlowMilestoneListing.
- :return: The first_uri of this FlowMilestoneListing.
+ :return: The last_uri of this FlowMilestoneListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this FlowMilestoneListing.
+ Sets the last_uri of this FlowMilestoneListing.
- :param first_uri: The first_uri of this FlowMilestoneListing.
+ :param last_uri: The last_uri of this FlowMilestoneListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/flow_outcome_detail_event_topic_flow_outcome_event.py b/build/PureCloudPlatformClientV2/models/flow_outcome_detail_event_topic_flow_outcome_event.py
index 29525b4cc..1dafc87dd 100644
--- a/build/PureCloudPlatformClientV2/models/flow_outcome_detail_event_topic_flow_outcome_event.py
+++ b/build/PureCloudPlatformClientV2/models/flow_outcome_detail_event_topic_flow_outcome_event.py
@@ -448,7 +448,7 @@ def message_type(self, message_type: str) -> None:
"""
if isinstance(message_type, int):
message_type = str(message_type)
- allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM"]
+ allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM", "APPLE"]
if message_type.lower() not in map(str.lower, allowed_values):
# print("Invalid value for message_type -> " + message_type)
self._message_type = "outdated_sdk_version"
diff --git a/build/PureCloudPlatformClientV2/models/flow_outcome_division_view_entity_listing.py b/build/PureCloudPlatformClientV2/models/flow_outcome_division_view_entity_listing.py
index d86e90bc2..d821e0918 100644
--- a/build/PureCloudPlatformClientV2/models/flow_outcome_division_view_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/flow_outcome_division_view_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this FlowOutcomeDivisionViewEntityListing.
+ Gets the first_uri of this FlowOutcomeDivisionViewEntityListing.
- :return: The last_uri of this FlowOutcomeDivisionViewEntityListing.
+ :return: The first_uri of this FlowOutcomeDivisionViewEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this FlowOutcomeDivisionViewEntityListing.
+ Sets the first_uri of this FlowOutcomeDivisionViewEntityListing.
- :param last_uri: The last_uri of this FlowOutcomeDivisionViewEntityListing.
+ :param first_uri: The first_uri of this FlowOutcomeDivisionViewEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this FlowOutcomeDivisionViewEntityListing.
+ Gets the last_uri of this FlowOutcomeDivisionViewEntityListing.
- :return: The first_uri of this FlowOutcomeDivisionViewEntityListing.
+ :return: The last_uri of this FlowOutcomeDivisionViewEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this FlowOutcomeDivisionViewEntityListing.
+ Sets the last_uri of this FlowOutcomeDivisionViewEntityListing.
- :param first_uri: The first_uri of this FlowOutcomeDivisionViewEntityListing.
+ :param last_uri: The last_uri of this FlowOutcomeDivisionViewEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/flow_outcome_listing.py b/build/PureCloudPlatformClientV2/models/flow_outcome_listing.py
index 61aa257ed..72d9a209e 100644
--- a/build/PureCloudPlatformClientV2/models/flow_outcome_listing.py
+++ b/build/PureCloudPlatformClientV2/models/flow_outcome_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this FlowOutcomeListing.
+ Gets the first_uri of this FlowOutcomeListing.
- :return: The last_uri of this FlowOutcomeListing.
+ :return: The first_uri of this FlowOutcomeListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this FlowOutcomeListing.
+ Sets the first_uri of this FlowOutcomeListing.
- :param last_uri: The last_uri of this FlowOutcomeListing.
+ :param first_uri: The first_uri of this FlowOutcomeListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this FlowOutcomeListing.
+ Gets the last_uri of this FlowOutcomeListing.
- :return: The first_uri of this FlowOutcomeListing.
+ :return: The last_uri of this FlowOutcomeListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this FlowOutcomeListing.
+ Sets the last_uri of this FlowOutcomeListing.
- :param first_uri: The first_uri of this FlowOutcomeListing.
+ :param last_uri: The last_uri of this FlowOutcomeListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/flow_result_entity_listing.py b/build/PureCloudPlatformClientV2/models/flow_result_entity_listing.py
index 2520488b8..6e726dba8 100644
--- a/build/PureCloudPlatformClientV2/models/flow_result_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/flow_result_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this FlowResultEntityListing.
+ Gets the first_uri of this FlowResultEntityListing.
- :return: The last_uri of this FlowResultEntityListing.
+ :return: The first_uri of this FlowResultEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this FlowResultEntityListing.
+ Sets the first_uri of this FlowResultEntityListing.
- :param last_uri: The last_uri of this FlowResultEntityListing.
+ :param first_uri: The first_uri of this FlowResultEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this FlowResultEntityListing.
+ Gets the last_uri of this FlowResultEntityListing.
- :return: The first_uri of this FlowResultEntityListing.
+ :return: The last_uri of this FlowResultEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this FlowResultEntityListing.
+ Sets the last_uri of this FlowResultEntityListing.
- :param first_uri: The first_uri of this FlowResultEntityListing.
+ :param last_uri: The last_uri of this FlowResultEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/flow_settings_response_entity_listing.py b/build/PureCloudPlatformClientV2/models/flow_settings_response_entity_listing.py
index a1189d1bc..a58f67666 100644
--- a/build/PureCloudPlatformClientV2/models/flow_settings_response_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/flow_settings_response_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this FlowSettingsResponseEntityListing.
+ Gets the first_uri of this FlowSettingsResponseEntityListing.
- :return: The last_uri of this FlowSettingsResponseEntityListing.
+ :return: The first_uri of this FlowSettingsResponseEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this FlowSettingsResponseEntityListing.
+ Sets the first_uri of this FlowSettingsResponseEntityListing.
- :param last_uri: The last_uri of this FlowSettingsResponseEntityListing.
+ :param first_uri: The first_uri of this FlowSettingsResponseEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this FlowSettingsResponseEntityListing.
+ Gets the last_uri of this FlowSettingsResponseEntityListing.
- :return: The first_uri of this FlowSettingsResponseEntityListing.
+ :return: The last_uri of this FlowSettingsResponseEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this FlowSettingsResponseEntityListing.
+ Sets the last_uri of this FlowSettingsResponseEntityListing.
- :param first_uri: The first_uri of this FlowSettingsResponseEntityListing.
+ :param last_uri: The last_uri of this FlowSettingsResponseEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/flow_start_detail_event_topic_flow_start_event.py b/build/PureCloudPlatformClientV2/models/flow_start_detail_event_topic_flow_start_event.py
index 1759e50f6..2c8533f9e 100644
--- a/build/PureCloudPlatformClientV2/models/flow_start_detail_event_topic_flow_start_event.py
+++ b/build/PureCloudPlatformClientV2/models/flow_start_detail_event_topic_flow_start_event.py
@@ -431,7 +431,7 @@ def message_type(self, message_type: str) -> None:
"""
if isinstance(message_type, int):
message_type = str(message_type)
- allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM"]
+ allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM", "APPLE"]
if message_type.lower() not in map(str.lower, allowed_values):
# print("Invalid value for message_type -> " + message_type)
self._message_type = "outdated_sdk_version"
diff --git a/build/PureCloudPlatformClientV2/models/flow_version_entity_listing.py b/build/PureCloudPlatformClientV2/models/flow_version_entity_listing.py
index ed0a4565e..dd4796ffd 100644
--- a/build/PureCloudPlatformClientV2/models/flow_version_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/flow_version_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this FlowVersionEntityListing.
+ Gets the first_uri of this FlowVersionEntityListing.
- :return: The last_uri of this FlowVersionEntityListing.
+ :return: The first_uri of this FlowVersionEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this FlowVersionEntityListing.
+ Sets the first_uri of this FlowVersionEntityListing.
- :param last_uri: The last_uri of this FlowVersionEntityListing.
+ :param first_uri: The first_uri of this FlowVersionEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this FlowVersionEntityListing.
+ Gets the last_uri of this FlowVersionEntityListing.
- :return: The first_uri of this FlowVersionEntityListing.
+ :return: The last_uri of this FlowVersionEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this FlowVersionEntityListing.
+ Sets the last_uri of this FlowVersionEntityListing.
- :param first_uri: The first_uri of this FlowVersionEntityListing.
+ :param last_uri: The last_uri of this FlowVersionEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/function.py b/build/PureCloudPlatformClientV2/models/function.py
index 45a7039dd..5a9b013b1 100644
--- a/build/PureCloudPlatformClientV2/models/function.py
+++ b/build/PureCloudPlatformClientV2/models/function.py
@@ -250,7 +250,7 @@ def runtime(self, runtime: str) -> None:
def timeout_seconds(self) -> int:
"""
Gets the timeout_seconds of this Function.
- Execution timeout to apply to function. Value is in seconds. Range allowed 1 to 60. Default value 15 seconds.
+ Execution timeout to apply to function. Value is in seconds. Range allowed 1 to 15. Default value 15 seconds.
:return: The timeout_seconds of this Function.
:rtype: int
@@ -261,12 +261,18 @@ def timeout_seconds(self) -> int:
def timeout_seconds(self, timeout_seconds: int) -> None:
"""
Sets the timeout_seconds of this Function.
- Execution timeout to apply to function. Value is in seconds. Range allowed 1 to 60. Default value 15 seconds.
+ Execution timeout to apply to function. Value is in seconds. Range allowed 1 to 15. Default value 15 seconds.
:param timeout_seconds: The timeout_seconds of this Function.
:type: int
"""
+ if timeout_seconds > 15:
+ raise ValueError("Invalid value for `timeout_seconds`, must be a value less than or equal to `15`")
+
+ if timeout_seconds < 1:
+ raise ValueError("Invalid value for `timeout_seconds`, must be a value greater than or equal to `1`")
+
self._timeout_seconds = timeout_seconds
diff --git a/build/PureCloudPlatformClientV2/models/function_config.py b/build/PureCloudPlatformClientV2/models/function_config.py
index 789d9a218..6e8d6cea6 100644
--- a/build/PureCloudPlatformClientV2/models/function_config.py
+++ b/build/PureCloudPlatformClientV2/models/function_config.py
@@ -54,6 +54,7 @@ def __init__(self) -> None:
'id': 'str',
'function': 'Function',
'zip': 'FunctionZipConfig',
+ 'upload_exception_history': 'list[FunctionZipConfig]',
'self_uri': 'str'
}
@@ -61,12 +62,14 @@ def __init__(self) -> None:
'id': 'id',
'function': 'function',
'zip': 'zip',
+ 'upload_exception_history': 'uploadExceptionHistory',
'self_uri': 'selfUri'
}
self._id = None
self._function = None
self._zip = None
+ self._upload_exception_history = None
self._self_uri = None
@property
@@ -141,6 +144,30 @@ def zip(self, zip: 'FunctionZipConfig') -> None:
self._zip = zip
+ @property
+ def upload_exception_history(self) -> List['FunctionZipConfig']:
+ """
+ Gets the upload_exception_history of this FunctionConfig.
+ History of failed zip upload file configuration including their state and error messages. Contains no more than last ten failures.
+
+ :return: The upload_exception_history of this FunctionConfig.
+ :rtype: list[FunctionZipConfig]
+ """
+ return self._upload_exception_history
+
+ @upload_exception_history.setter
+ def upload_exception_history(self, upload_exception_history: List['FunctionZipConfig']) -> None:
+ """
+ Sets the upload_exception_history of this FunctionConfig.
+ History of failed zip upload file configuration including their state and error messages. Contains no more than last ten failures.
+
+ :param upload_exception_history: The upload_exception_history of this FunctionConfig.
+ :type: list[FunctionZipConfig]
+ """
+
+
+ self._upload_exception_history = upload_exception_history
+
@property
def self_uri(self) -> str:
"""
diff --git a/build/PureCloudPlatformClientV2/models/function_zip_config.py b/build/PureCloudPlatformClientV2/models/function_zip_config.py
index ef15640a4..887157117 100644
--- a/build/PureCloudPlatformClientV2/models/function_zip_config.py
+++ b/build/PureCloudPlatformClientV2/models/function_zip_config.py
@@ -51,20 +51,26 @@ def __init__(self) -> None:
'status': 'str',
'id': 'str',
'name': 'str',
- 'date_created': 'datetime'
+ 'date_created': 'datetime',
+ 'error_message': 'str',
+ 'request_id': 'str'
}
self.attribute_map = {
'status': 'status',
'id': 'id',
'name': 'name',
- 'date_created': 'dateCreated'
+ 'date_created': 'dateCreated',
+ 'error_message': 'errorMessage',
+ 'request_id': 'requestId'
}
self._status = None
self._id = None
self._name = None
self._date_created = None
+ self._error_message = None
+ self._request_id = None
@property
def status(self) -> str:
@@ -167,6 +173,54 @@ def date_created(self, date_created: datetime) -> None:
self._date_created = date_created
+ @property
+ def error_message(self) -> str:
+ """
+ Gets the error_message of this FunctionZipConfig.
+ Error message if upload failed.
+
+ :return: The error_message of this FunctionZipConfig.
+ :rtype: str
+ """
+ return self._error_message
+
+ @error_message.setter
+ def error_message(self, error_message: str) -> None:
+ """
+ Sets the error_message of this FunctionZipConfig.
+ Error message if upload failed.
+
+ :param error_message: The error_message of this FunctionZipConfig.
+ :type: str
+ """
+
+
+ self._error_message = error_message
+
+ @property
+ def request_id(self) -> str:
+ """
+ Gets the request_id of this FunctionZipConfig.
+ Upload request id used for zip upload
+
+ :return: The request_id of this FunctionZipConfig.
+ :rtype: str
+ """
+ return self._request_id
+
+ @request_id.setter
+ def request_id(self, request_id: str) -> None:
+ """
+ Sets the request_id of this FunctionZipConfig.
+ Upload request id used for zip upload
+
+ :param request_id: The request_id of this FunctionZipConfig.
+ :type: str
+ """
+
+
+ self._request_id = request_id
+
def to_dict(self):
"""
Returns the model properties as a dict
diff --git a/build/PureCloudPlatformClientV2/models/gdpr_request_entity_listing.py b/build/PureCloudPlatformClientV2/models/gdpr_request_entity_listing.py
index 4ac9caabe..3e0c18606 100644
--- a/build/PureCloudPlatformClientV2/models/gdpr_request_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/gdpr_request_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this GDPRRequestEntityListing.
+ Gets the first_uri of this GDPRRequestEntityListing.
- :return: The last_uri of this GDPRRequestEntityListing.
+ :return: The first_uri of this GDPRRequestEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this GDPRRequestEntityListing.
+ Sets the first_uri of this GDPRRequestEntityListing.
- :param last_uri: The last_uri of this GDPRRequestEntityListing.
+ :param first_uri: The first_uri of this GDPRRequestEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this GDPRRequestEntityListing.
+ Gets the last_uri of this GDPRRequestEntityListing.
- :return: The first_uri of this GDPRRequestEntityListing.
+ :return: The last_uri of this GDPRRequestEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this GDPRRequestEntityListing.
+ Sets the last_uri of this GDPRRequestEntityListing.
- :param first_uri: The first_uri of this GDPRRequestEntityListing.
+ :param last_uri: The last_uri of this GDPRRequestEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/gdpr_subject_entity_listing.py b/build/PureCloudPlatformClientV2/models/gdpr_subject_entity_listing.py
index 0b41df1b0..ba16aee54 100644
--- a/build/PureCloudPlatformClientV2/models/gdpr_subject_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/gdpr_subject_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this GDPRSubjectEntityListing.
+ Gets the first_uri of this GDPRSubjectEntityListing.
- :return: The last_uri of this GDPRSubjectEntityListing.
+ :return: The first_uri of this GDPRSubjectEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this GDPRSubjectEntityListing.
+ Sets the first_uri of this GDPRSubjectEntityListing.
- :param last_uri: The last_uri of this GDPRSubjectEntityListing.
+ :param first_uri: The first_uri of this GDPRSubjectEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this GDPRSubjectEntityListing.
+ Gets the last_uri of this GDPRSubjectEntityListing.
- :return: The first_uri of this GDPRSubjectEntityListing.
+ :return: The last_uri of this GDPRSubjectEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this GDPRSubjectEntityListing.
+ Sets the last_uri of this GDPRSubjectEntityListing.
- :param first_uri: The first_uri of this GDPRSubjectEntityListing.
+ :param last_uri: The last_uri of this GDPRSubjectEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/get_celebration_listing.py b/build/PureCloudPlatformClientV2/models/get_celebration_listing.py
index e0a649a85..b9549d57b 100644
--- a/build/PureCloudPlatformClientV2/models/get_celebration_listing.py
+++ b/build/PureCloudPlatformClientV2/models/get_celebration_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this GetCelebrationListing.
+ Gets the first_uri of this GetCelebrationListing.
- :return: The last_uri of this GetCelebrationListing.
+ :return: The first_uri of this GetCelebrationListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this GetCelebrationListing.
+ Sets the first_uri of this GetCelebrationListing.
- :param last_uri: The last_uri of this GetCelebrationListing.
+ :param first_uri: The first_uri of this GetCelebrationListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this GetCelebrationListing.
+ Gets the last_uri of this GetCelebrationListing.
- :return: The first_uri of this GetCelebrationListing.
+ :return: The last_uri of this GetCelebrationListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this GetCelebrationListing.
+ Sets the last_uri of this GetCelebrationListing.
- :param first_uri: The first_uri of this GetCelebrationListing.
+ :param last_uri: The last_uri of this GetCelebrationListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/google_dialogflow_config.py b/build/PureCloudPlatformClientV2/models/google_dialogflow_config.py
new file mode 100644
index 000000000..665d1609d
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/google_dialogflow_config.py
@@ -0,0 +1,168 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import ConversationProfile
+
+class GoogleDialogflowConfig(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ GoogleDialogflowConfig - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'integration_id': 'str',
+ 'conversation_profiles': 'list[ConversationProfile]'
+ }
+
+ self.attribute_map = {
+ 'integration_id': 'integrationId',
+ 'conversation_profiles': 'conversationProfiles'
+ }
+
+ self._integration_id = None
+ self._conversation_profiles = None
+
+ @property
+ def integration_id(self) -> str:
+ """
+ Gets the integration_id of this GoogleDialogflowConfig.
+ The integration identifier with which the assistant will fetch transcriptions and knowledge suggestions.
+
+ :return: The integration_id of this GoogleDialogflowConfig.
+ :rtype: str
+ """
+ return self._integration_id
+
+ @integration_id.setter
+ def integration_id(self, integration_id: str) -> None:
+ """
+ Sets the integration_id of this GoogleDialogflowConfig.
+ The integration identifier with which the assistant will fetch transcriptions and knowledge suggestions.
+
+ :param integration_id: The integration_id of this GoogleDialogflowConfig.
+ :type: str
+ """
+
+
+ self._integration_id = integration_id
+
+ @property
+ def conversation_profiles(self) -> List['ConversationProfile']:
+ """
+ Gets the conversation_profiles of this GoogleDialogflowConfig.
+ The conversation profiles for which the assistant will fetch transcription and knowledge suggestions.
+
+ :return: The conversation_profiles of this GoogleDialogflowConfig.
+ :rtype: list[ConversationProfile]
+ """
+ return self._conversation_profiles
+
+ @conversation_profiles.setter
+ def conversation_profiles(self, conversation_profiles: List['ConversationProfile']) -> None:
+ """
+ Sets the conversation_profiles of this GoogleDialogflowConfig.
+ The conversation profiles for which the assistant will fetch transcription and knowledge suggestions.
+
+ :param conversation_profiles: The conversation_profiles of this GoogleDialogflowConfig.
+ :type: list[ConversationProfile]
+ """
+
+
+ self._conversation_profiles = conversation_profiles
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/grammar_listing.py b/build/PureCloudPlatformClientV2/models/grammar_listing.py
index 9008159d4..065f8fb81 100644
--- a/build/PureCloudPlatformClientV2/models/grammar_listing.py
+++ b/build/PureCloudPlatformClientV2/models/grammar_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this GrammarListing.
+ Gets the first_uri of this GrammarListing.
- :return: The last_uri of this GrammarListing.
+ :return: The first_uri of this GrammarListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this GrammarListing.
+ Sets the first_uri of this GrammarListing.
- :param last_uri: The last_uri of this GrammarListing.
+ :param first_uri: The first_uri of this GrammarListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this GrammarListing.
+ Gets the last_uri of this GrammarListing.
- :return: The first_uri of this GrammarListing.
+ :return: The last_uri of this GrammarListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this GrammarListing.
+ Sets the last_uri of this GrammarListing.
- :param first_uri: The first_uri of this GrammarListing.
+ :param last_uri: The last_uri of this GrammarListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/greeting_listing.py b/build/PureCloudPlatformClientV2/models/greeting_listing.py
index 9188deecd..b2ff72e54 100644
--- a/build/PureCloudPlatformClientV2/models/greeting_listing.py
+++ b/build/PureCloudPlatformClientV2/models/greeting_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this GreetingListing.
+ Gets the first_uri of this GreetingListing.
- :return: The last_uri of this GreetingListing.
+ :return: The first_uri of this GreetingListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this GreetingListing.
+ Sets the first_uri of this GreetingListing.
- :param last_uri: The last_uri of this GreetingListing.
+ :param first_uri: The first_uri of this GreetingListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this GreetingListing.
+ Gets the last_uri of this GreetingListing.
- :return: The first_uri of this GreetingListing.
+ :return: The last_uri of this GreetingListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this GreetingListing.
+ Sets the last_uri of this GreetingListing.
- :param first_uri: The first_uri of this GreetingListing.
+ :param last_uri: The last_uri of this GreetingListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/group_entity_listing.py b/build/PureCloudPlatformClientV2/models/group_entity_listing.py
index 6816bb572..9e3848773 100644
--- a/build/PureCloudPlatformClientV2/models/group_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/group_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this GroupEntityListing.
+ Gets the first_uri of this GroupEntityListing.
- :return: The last_uri of this GroupEntityListing.
+ :return: The first_uri of this GroupEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this GroupEntityListing.
+ Sets the first_uri of this GroupEntityListing.
- :param last_uri: The last_uri of this GroupEntityListing.
+ :param first_uri: The first_uri of this GroupEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this GroupEntityListing.
+ Gets the last_uri of this GroupEntityListing.
- :return: The first_uri of this GroupEntityListing.
+ :return: The last_uri of this GroupEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this GroupEntityListing.
+ Sets the last_uri of this GroupEntityListing.
- :param first_uri: The first_uri of this GroupEntityListing.
+ :param last_uri: The last_uri of this GroupEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/group_profile_entity_listing.py b/build/PureCloudPlatformClientV2/models/group_profile_entity_listing.py
index 987e5ae4f..8a9e02d71 100644
--- a/build/PureCloudPlatformClientV2/models/group_profile_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/group_profile_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this GroupProfileEntityListing.
+ Gets the first_uri of this GroupProfileEntityListing.
- :return: The last_uri of this GroupProfileEntityListing.
+ :return: The first_uri of this GroupProfileEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this GroupProfileEntityListing.
+ Sets the first_uri of this GroupProfileEntityListing.
- :param last_uri: The last_uri of this GroupProfileEntityListing.
+ :param first_uri: The first_uri of this GroupProfileEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this GroupProfileEntityListing.
+ Gets the last_uri of this GroupProfileEntityListing.
- :return: The first_uri of this GroupProfileEntityListing.
+ :return: The last_uri of this GroupProfileEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this GroupProfileEntityListing.
+ Sets the last_uri of this GroupProfileEntityListing.
- :param first_uri: The first_uri of this GroupProfileEntityListing.
+ :param last_uri: The last_uri of this GroupProfileEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/identity_provider_entity_listing.py b/build/PureCloudPlatformClientV2/models/identity_provider_entity_listing.py
index b6fe7db86..9f059bca1 100644
--- a/build/PureCloudPlatformClientV2/models/identity_provider_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/identity_provider_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this IdentityProviderEntityListing.
+ Gets the first_uri of this IdentityProviderEntityListing.
- :return: The last_uri of this IdentityProviderEntityListing.
+ :return: The first_uri of this IdentityProviderEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this IdentityProviderEntityListing.
+ Sets the first_uri of this IdentityProviderEntityListing.
- :param last_uri: The last_uri of this IdentityProviderEntityListing.
+ :param first_uri: The first_uri of this IdentityProviderEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this IdentityProviderEntityListing.
+ Gets the last_uri of this IdentityProviderEntityListing.
- :return: The first_uri of this IdentityProviderEntityListing.
+ :return: The last_uri of this IdentityProviderEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this IdentityProviderEntityListing.
+ Sets the last_uri of this IdentityProviderEntityListing.
- :param first_uri: The first_uri of this IdentityProviderEntityListing.
+ :param last_uri: The last_uri of this IdentityProviderEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/import_template_entity_listing.py b/build/PureCloudPlatformClientV2/models/import_template_entity_listing.py
index cbd29579c..1b9d2fa72 100644
--- a/build/PureCloudPlatformClientV2/models/import_template_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/import_template_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ImportTemplateEntityListing.
+ Gets the first_uri of this ImportTemplateEntityListing.
- :return: The last_uri of this ImportTemplateEntityListing.
+ :return: The first_uri of this ImportTemplateEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ImportTemplateEntityListing.
+ Sets the first_uri of this ImportTemplateEntityListing.
- :param last_uri: The last_uri of this ImportTemplateEntityListing.
+ :param first_uri: The first_uri of this ImportTemplateEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ImportTemplateEntityListing.
+ Gets the last_uri of this ImportTemplateEntityListing.
- :return: The first_uri of this ImportTemplateEntityListing.
+ :return: The last_uri of this ImportTemplateEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ImportTemplateEntityListing.
+ Sets the last_uri of this ImportTemplateEntityListing.
- :param first_uri: The first_uri of this ImportTemplateEntityListing.
+ :param last_uri: The last_uri of this ImportTemplateEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/inbound_domain_entity_listing.py b/build/PureCloudPlatformClientV2/models/inbound_domain_entity_listing.py
index 04d6665ff..f9f31287e 100644
--- a/build/PureCloudPlatformClientV2/models/inbound_domain_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/inbound_domain_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this InboundDomainEntityListing.
+ Gets the first_uri of this InboundDomainEntityListing.
- :return: The last_uri of this InboundDomainEntityListing.
+ :return: The first_uri of this InboundDomainEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this InboundDomainEntityListing.
+ Sets the first_uri of this InboundDomainEntityListing.
- :param last_uri: The last_uri of this InboundDomainEntityListing.
+ :param first_uri: The first_uri of this InboundDomainEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this InboundDomainEntityListing.
+ Gets the last_uri of this InboundDomainEntityListing.
- :return: The first_uri of this InboundDomainEntityListing.
+ :return: The last_uri of this InboundDomainEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this InboundDomainEntityListing.
+ Sets the last_uri of this InboundDomainEntityListing.
- :param first_uri: The first_uri of this InboundDomainEntityListing.
+ :param last_uri: The last_uri of this InboundDomainEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/inbound_route_entity_listing.py b/build/PureCloudPlatformClientV2/models/inbound_route_entity_listing.py
index e0246df93..e99db2616 100644
--- a/build/PureCloudPlatformClientV2/models/inbound_route_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/inbound_route_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this InboundRouteEntityListing.
+ Gets the first_uri of this InboundRouteEntityListing.
- :return: The last_uri of this InboundRouteEntityListing.
+ :return: The first_uri of this InboundRouteEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this InboundRouteEntityListing.
+ Sets the first_uri of this InboundRouteEntityListing.
- :param last_uri: The last_uri of this InboundRouteEntityListing.
+ :param first_uri: The first_uri of this InboundRouteEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this InboundRouteEntityListing.
+ Gets the last_uri of this InboundRouteEntityListing.
- :return: The first_uri of this InboundRouteEntityListing.
+ :return: The last_uri of this InboundRouteEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this InboundRouteEntityListing.
+ Sets the last_uri of this InboundRouteEntityListing.
- :param first_uri: The first_uri of this InboundRouteEntityListing.
+ :param last_uri: The last_uri of this InboundRouteEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/instagram_integration_entity_listing.py b/build/PureCloudPlatformClientV2/models/instagram_integration_entity_listing.py
index e283400bf..66ce789cf 100644
--- a/build/PureCloudPlatformClientV2/models/instagram_integration_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/instagram_integration_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this InstagramIntegrationEntityListing.
+ Gets the first_uri of this InstagramIntegrationEntityListing.
- :return: The last_uri of this InstagramIntegrationEntityListing.
+ :return: The first_uri of this InstagramIntegrationEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this InstagramIntegrationEntityListing.
+ Sets the first_uri of this InstagramIntegrationEntityListing.
- :param last_uri: The last_uri of this InstagramIntegrationEntityListing.
+ :param first_uri: The first_uri of this InstagramIntegrationEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this InstagramIntegrationEntityListing.
+ Gets the last_uri of this InstagramIntegrationEntityListing.
- :return: The first_uri of this InstagramIntegrationEntityListing.
+ :return: The last_uri of this InstagramIntegrationEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this InstagramIntegrationEntityListing.
+ Sets the last_uri of this InstagramIntegrationEntityListing.
- :param first_uri: The first_uri of this InstagramIntegrationEntityListing.
+ :param last_uri: The last_uri of this InstagramIntegrationEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/integration_entity_listing.py b/build/PureCloudPlatformClientV2/models/integration_entity_listing.py
index 7c69787f0..b80bd976e 100644
--- a/build/PureCloudPlatformClientV2/models/integration_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/integration_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this IntegrationEntityListing.
+ Gets the first_uri of this IntegrationEntityListing.
- :return: The last_uri of this IntegrationEntityListing.
+ :return: The first_uri of this IntegrationEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this IntegrationEntityListing.
+ Sets the first_uri of this IntegrationEntityListing.
- :param last_uri: The last_uri of this IntegrationEntityListing.
+ :param first_uri: The first_uri of this IntegrationEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this IntegrationEntityListing.
+ Gets the last_uri of this IntegrationEntityListing.
- :return: The first_uri of this IntegrationEntityListing.
+ :return: The last_uri of this IntegrationEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this IntegrationEntityListing.
+ Sets the last_uri of this IntegrationEntityListing.
- :param first_uri: The first_uri of this IntegrationEntityListing.
+ :param last_uri: The last_uri of this IntegrationEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/integration_type_entity_listing.py b/build/PureCloudPlatformClientV2/models/integration_type_entity_listing.py
index a28a877f1..e72238d00 100644
--- a/build/PureCloudPlatformClientV2/models/integration_type_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/integration_type_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this IntegrationTypeEntityListing.
+ Gets the first_uri of this IntegrationTypeEntityListing.
- :return: The last_uri of this IntegrationTypeEntityListing.
+ :return: The first_uri of this IntegrationTypeEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this IntegrationTypeEntityListing.
+ Sets the first_uri of this IntegrationTypeEntityListing.
- :param last_uri: The last_uri of this IntegrationTypeEntityListing.
+ :param first_uri: The first_uri of this IntegrationTypeEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this IntegrationTypeEntityListing.
+ Gets the last_uri of this IntegrationTypeEntityListing.
- :return: The first_uri of this IntegrationTypeEntityListing.
+ :return: The last_uri of this IntegrationTypeEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this IntegrationTypeEntityListing.
+ Sets the last_uri of this IntegrationTypeEntityListing.
- :param first_uri: The first_uri of this IntegrationTypeEntityListing.
+ :param last_uri: The last_uri of this IntegrationTypeEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/interaction_stats_alert_container.py b/build/PureCloudPlatformClientV2/models/interaction_stats_alert_container.py
index bbd1268a1..97b4f9ca9 100644
--- a/build/PureCloudPlatformClientV2/models/interaction_stats_alert_container.py
+++ b/build/PureCloudPlatformClientV2/models/interaction_stats_alert_container.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this InteractionStatsAlertContainer.
+ Gets the first_uri of this InteractionStatsAlertContainer.
- :return: The last_uri of this InteractionStatsAlertContainer.
+ :return: The first_uri of this InteractionStatsAlertContainer.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this InteractionStatsAlertContainer.
+ Sets the first_uri of this InteractionStatsAlertContainer.
- :param last_uri: The last_uri of this InteractionStatsAlertContainer.
+ :param first_uri: The first_uri of this InteractionStatsAlertContainer.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this InteractionStatsAlertContainer.
+ Gets the last_uri of this InteractionStatsAlertContainer.
- :return: The first_uri of this InteractionStatsAlertContainer.
+ :return: The last_uri of this InteractionStatsAlertContainer.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this InteractionStatsAlertContainer.
+ Sets the last_uri of this InteractionStatsAlertContainer.
- :param first_uri: The first_uri of this InteractionStatsAlertContainer.
+ :param last_uri: The last_uri of this InteractionStatsAlertContainer.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/interaction_stats_rule_container.py b/build/PureCloudPlatformClientV2/models/interaction_stats_rule_container.py
index a4d8b50ae..746013b28 100644
--- a/build/PureCloudPlatformClientV2/models/interaction_stats_rule_container.py
+++ b/build/PureCloudPlatformClientV2/models/interaction_stats_rule_container.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this InteractionStatsRuleContainer.
+ Gets the first_uri of this InteractionStatsRuleContainer.
- :return: The last_uri of this InteractionStatsRuleContainer.
+ :return: The first_uri of this InteractionStatsRuleContainer.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this InteractionStatsRuleContainer.
+ Sets the first_uri of this InteractionStatsRuleContainer.
- :param last_uri: The last_uri of this InteractionStatsRuleContainer.
+ :param first_uri: The first_uri of this InteractionStatsRuleContainer.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this InteractionStatsRuleContainer.
+ Gets the last_uri of this InteractionStatsRuleContainer.
- :return: The first_uri of this InteractionStatsRuleContainer.
+ :return: The last_uri of this InteractionStatsRuleContainer.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this InteractionStatsRuleContainer.
+ Sets the last_uri of this InteractionStatsRuleContainer.
- :param first_uri: The first_uri of this InteractionStatsRuleContainer.
+ :param last_uri: The last_uri of this InteractionStatsRuleContainer.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/ip_address_range.py b/build/PureCloudPlatformClientV2/models/ip_address_range.py
index 145ed7202..ccf80a3c1 100644
--- a/build/PureCloudPlatformClientV2/models/ip_address_range.py
+++ b/build/PureCloudPlatformClientV2/models/ip_address_range.py
@@ -109,7 +109,7 @@ def service(self, service: str) -> None:
"""
if isinstance(service, int):
service = str(service)
- allowed_values = ["data-actions", "smtp", "audiohook", "open-messaging", "api"]
+ allowed_values = ["data-actions", "smtp", "audiohook", "open-messaging", "api", "audio-connector"]
if service.lower() not in map(str.lower, allowed_values):
# print("Invalid value for service -> " + service)
self._service = "outdated_sdk_version"
diff --git a/build/PureCloudPlatformClientV2/models/ivr_division_view_entity_listing.py b/build/PureCloudPlatformClientV2/models/ivr_division_view_entity_listing.py
index c2ed166b6..c0c2e54c7 100644
--- a/build/PureCloudPlatformClientV2/models/ivr_division_view_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/ivr_division_view_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this IVRDivisionViewEntityListing.
+ Gets the first_uri of this IVRDivisionViewEntityListing.
- :return: The last_uri of this IVRDivisionViewEntityListing.
+ :return: The first_uri of this IVRDivisionViewEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this IVRDivisionViewEntityListing.
+ Sets the first_uri of this IVRDivisionViewEntityListing.
- :param last_uri: The last_uri of this IVRDivisionViewEntityListing.
+ :param first_uri: The first_uri of this IVRDivisionViewEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this IVRDivisionViewEntityListing.
+ Gets the last_uri of this IVRDivisionViewEntityListing.
- :return: The first_uri of this IVRDivisionViewEntityListing.
+ :return: The last_uri of this IVRDivisionViewEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this IVRDivisionViewEntityListing.
+ Sets the last_uri of this IVRDivisionViewEntityListing.
- :param first_uri: The first_uri of this IVRDivisionViewEntityListing.
+ :param last_uri: The last_uri of this IVRDivisionViewEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/ivr_entity_listing.py b/build/PureCloudPlatformClientV2/models/ivr_entity_listing.py
index d0f4a7980..96ea27b5d 100644
--- a/build/PureCloudPlatformClientV2/models/ivr_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/ivr_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this IVREntityListing.
+ Gets the first_uri of this IVREntityListing.
- :return: The last_uri of this IVREntityListing.
+ :return: The first_uri of this IVREntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this IVREntityListing.
+ Sets the first_uri of this IVREntityListing.
- :param last_uri: The last_uri of this IVREntityListing.
+ :param first_uri: The first_uri of this IVREntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this IVREntityListing.
+ Gets the last_uri of this IVREntityListing.
- :return: The first_uri of this IVREntityListing.
+ :return: The last_uri of this IVREntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this IVREntityListing.
+ Sets the last_uri of this IVREntityListing.
- :param first_uri: The first_uri of this IVREntityListing.
+ :param last_uri: The last_uri of this IVREntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/journey_view_element_filter_range_data.py b/build/PureCloudPlatformClientV2/models/journey_view_element_filter_range_data.py
index 8afb25dc5..e6f2341c7 100644
--- a/build/PureCloudPlatformClientV2/models/journey_view_element_filter_range_data.py
+++ b/build/PureCloudPlatformClientV2/models/journey_view_element_filter_range_data.py
@@ -49,7 +49,7 @@ def __init__(self) -> None:
"""
self.swagger_types = {
'duration': 'str',
- 'number': 'int'
+ 'number': 'float'
}
self.attribute_map = {
@@ -64,7 +64,7 @@ def __init__(self) -> None:
def duration(self) -> str:
"""
Gets the duration of this JourneyViewElementFilterRangeData.
- an ISO 8601 time duration.Only one of number or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
+ An ISO 8601 time duration. Only one of number or duration must be specified.
:return: The duration of this JourneyViewElementFilterRangeData.
:rtype: str
@@ -75,7 +75,7 @@ def duration(self) -> str:
def duration(self, duration: str) -> None:
"""
Sets the duration of this JourneyViewElementFilterRangeData.
- an ISO 8601 time duration.Only one of number or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
+ An ISO 8601 time duration. Only one of number or duration must be specified.
:param duration: The duration of this JourneyViewElementFilterRangeData.
:type: str
@@ -85,24 +85,24 @@ def duration(self, duration: str) -> None:
self._duration = duration
@property
- def number(self) -> int:
+ def number(self) -> float:
"""
Gets the number of this JourneyViewElementFilterRangeData.
- an Integer value.Only one of number or duration must be specified.
+ A numeric value. Only one of number or duration must be specified.
:return: The number of this JourneyViewElementFilterRangeData.
- :rtype: int
+ :rtype: float
"""
return self._number
@number.setter
- def number(self, number: int) -> None:
+ def number(self, number: float) -> None:
"""
Sets the number of this JourneyViewElementFilterRangeData.
- an Integer value.Only one of number or duration must be specified.
+ A numeric value. Only one of number or duration must be specified.
:param number: The number of this JourneyViewElementFilterRangeData.
- :type: int
+ :type: float
"""
diff --git a/build/PureCloudPlatformClientV2/models/journey_view_job_listing.py b/build/PureCloudPlatformClientV2/models/journey_view_job_listing.py
index 78b8c8333..a0079bd25 100644
--- a/build/PureCloudPlatformClientV2/models/journey_view_job_listing.py
+++ b/build/PureCloudPlatformClientV2/models/journey_view_job_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this JourneyViewJobListing.
+ Gets the first_uri of this JourneyViewJobListing.
- :return: The last_uri of this JourneyViewJobListing.
+ :return: The first_uri of this JourneyViewJobListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this JourneyViewJobListing.
+ Sets the first_uri of this JourneyViewJobListing.
- :param last_uri: The last_uri of this JourneyViewJobListing.
+ :param first_uri: The first_uri of this JourneyViewJobListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this JourneyViewJobListing.
+ Gets the last_uri of this JourneyViewJobListing.
- :return: The first_uri of this JourneyViewJobListing.
+ :return: The last_uri of this JourneyViewJobListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this JourneyViewJobListing.
+ Sets the last_uri of this JourneyViewJobListing.
- :param first_uri: The first_uri of this JourneyViewJobListing.
+ :param last_uri: The last_uri of this JourneyViewJobListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/journey_view_listing.py b/build/PureCloudPlatformClientV2/models/journey_view_listing.py
index 64ae33c38..c132c3446 100644
--- a/build/PureCloudPlatformClientV2/models/journey_view_listing.py
+++ b/build/PureCloudPlatformClientV2/models/journey_view_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this JourneyViewListing.
+ Gets the first_uri of this JourneyViewListing.
- :return: The last_uri of this JourneyViewListing.
+ :return: The first_uri of this JourneyViewListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this JourneyViewListing.
+ Sets the first_uri of this JourneyViewListing.
- :param last_uri: The last_uri of this JourneyViewListing.
+ :param first_uri: The first_uri of this JourneyViewListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this JourneyViewListing.
+ Gets the last_uri of this JourneyViewListing.
- :return: The first_uri of this JourneyViewListing.
+ :return: The last_uri of this JourneyViewListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this JourneyViewListing.
+ Sets the last_uri of this JourneyViewListing.
- :param first_uri: The first_uri of this JourneyViewListing.
+ :param last_uri: The last_uri of this JourneyViewListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/knowledge_answer_config.py b/build/PureCloudPlatformClientV2/models/knowledge_answer_config.py
new file mode 100644
index 000000000..f06b4032b
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/knowledge_answer_config.py
@@ -0,0 +1,139 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+
+class KnowledgeAnswerConfig(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ KnowledgeAnswerConfig - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'enabled': 'bool'
+ }
+
+ self.attribute_map = {
+ 'enabled': 'enabled'
+ }
+
+ self._enabled = None
+
+ @property
+ def enabled(self) -> bool:
+ """
+ Gets the enabled of this KnowledgeAnswerConfig.
+ Knowledge answer is enabled.
+
+ :return: The enabled of this KnowledgeAnswerConfig.
+ :rtype: bool
+ """
+ return self._enabled
+
+ @enabled.setter
+ def enabled(self, enabled: bool) -> None:
+ """
+ Sets the enabled of this KnowledgeAnswerConfig.
+ Knowledge answer is enabled.
+
+ :param enabled: The enabled of this KnowledgeAnswerConfig.
+ :type: bool
+ """
+
+
+ self._enabled = enabled
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/knowledge_answer_document_response.py b/build/PureCloudPlatformClientV2/models/knowledge_answer_document_response.py
new file mode 100644
index 000000000..c08c9a69d
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/knowledge_answer_document_response.py
@@ -0,0 +1,222 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import DocumentVariationAnswer
+
+class KnowledgeAnswerDocumentResponse(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ KnowledgeAnswerDocumentResponse - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'id': 'str',
+ 'title': 'str',
+ 'answer': 'str',
+ 'variation': 'DocumentVariationAnswer'
+ }
+
+ self.attribute_map = {
+ 'id': 'id',
+ 'title': 'title',
+ 'answer': 'answer',
+ 'variation': 'variation'
+ }
+
+ self._id = None
+ self._title = None
+ self._answer = None
+ self._variation = None
+
+ @property
+ def id(self) -> str:
+ """
+ Gets the id of this KnowledgeAnswerDocumentResponse.
+ The document id.
+
+ :return: The id of this KnowledgeAnswerDocumentResponse.
+ :rtype: str
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id: str) -> None:
+ """
+ Sets the id of this KnowledgeAnswerDocumentResponse.
+ The document id.
+
+ :param id: The id of this KnowledgeAnswerDocumentResponse.
+ :type: str
+ """
+
+
+ self._id = id
+
+ @property
+ def title(self) -> str:
+ """
+ Gets the title of this KnowledgeAnswerDocumentResponse.
+ The document title.
+
+ :return: The title of this KnowledgeAnswerDocumentResponse.
+ :rtype: str
+ """
+ return self._title
+
+ @title.setter
+ def title(self, title: str) -> None:
+ """
+ Sets the title of this KnowledgeAnswerDocumentResponse.
+ The document title.
+
+ :param title: The title of this KnowledgeAnswerDocumentResponse.
+ :type: str
+ """
+
+
+ self._title = title
+
+ @property
+ def answer(self) -> str:
+ """
+ Gets the answer of this KnowledgeAnswerDocumentResponse.
+ The answer found inside a variationContent.
+
+ :return: The answer of this KnowledgeAnswerDocumentResponse.
+ :rtype: str
+ """
+ return self._answer
+
+ @answer.setter
+ def answer(self, answer: str) -> None:
+ """
+ Sets the answer of this KnowledgeAnswerDocumentResponse.
+ The answer found inside a variationContent.
+
+ :param answer: The answer of this KnowledgeAnswerDocumentResponse.
+ :type: str
+ """
+
+
+ self._answer = answer
+
+ @property
+ def variation(self) -> 'DocumentVariationAnswer':
+ """
+ Gets the variation of this KnowledgeAnswerDocumentResponse.
+ The variation with the answer's highlight data.
+
+ :return: The variation of this KnowledgeAnswerDocumentResponse.
+ :rtype: DocumentVariationAnswer
+ """
+ return self._variation
+
+ @variation.setter
+ def variation(self, variation: 'DocumentVariationAnswer') -> None:
+ """
+ Sets the variation of this KnowledgeAnswerDocumentResponse.
+ The variation with the answer's highlight data.
+
+ :param variation: The variation of this KnowledgeAnswerDocumentResponse.
+ :type: DocumentVariationAnswer
+ """
+
+
+ self._variation = variation
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/knowledge_answer_documents_response.py b/build/PureCloudPlatformClientV2/models/knowledge_answer_documents_response.py
new file mode 100644
index 000000000..f3f2ce8ca
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/knowledge_answer_documents_response.py
@@ -0,0 +1,169 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import KnowledgeAnswerDocumentResponse
+ from . import KnowledgeAnswerGenerationResponse
+
+class KnowledgeAnswerDocumentsResponse(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ KnowledgeAnswerDocumentsResponse - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'results': 'list[KnowledgeAnswerDocumentResponse]',
+ 'answer_generation': 'KnowledgeAnswerGenerationResponse'
+ }
+
+ self.attribute_map = {
+ 'results': 'results',
+ 'answer_generation': 'answerGeneration'
+ }
+
+ self._results = None
+ self._answer_generation = None
+
+ @property
+ def results(self) -> List['KnowledgeAnswerDocumentResponse']:
+ """
+ Gets the results of this KnowledgeAnswerDocumentsResponse.
+ The results with answers if the answerMode request property is not set or contains \"AnswerHighlight\". Empty array otherwise.
+
+ :return: The results of this KnowledgeAnswerDocumentsResponse.
+ :rtype: list[KnowledgeAnswerDocumentResponse]
+ """
+ return self._results
+
+ @results.setter
+ def results(self, results: List['KnowledgeAnswerDocumentResponse']) -> None:
+ """
+ Sets the results of this KnowledgeAnswerDocumentsResponse.
+ The results with answers if the answerMode request property is not set or contains \"AnswerHighlight\". Empty array otherwise.
+
+ :param results: The results of this KnowledgeAnswerDocumentsResponse.
+ :type: list[KnowledgeAnswerDocumentResponse]
+ """
+
+
+ self._results = results
+
+ @property
+ def answer_generation(self) -> 'KnowledgeAnswerGenerationResponse':
+ """
+ Gets the answer_generation of this KnowledgeAnswerDocumentsResponse.
+ The results with AI-generated answer if the answerMode request property contains \"AnswerGeneration\".
+
+ :return: The answer_generation of this KnowledgeAnswerDocumentsResponse.
+ :rtype: KnowledgeAnswerGenerationResponse
+ """
+ return self._answer_generation
+
+ @answer_generation.setter
+ def answer_generation(self, answer_generation: 'KnowledgeAnswerGenerationResponse') -> None:
+ """
+ Sets the answer_generation of this KnowledgeAnswerDocumentsResponse.
+ The results with AI-generated answer if the answerMode request property contains \"AnswerGeneration\".
+
+ :param answer_generation: The answer_generation of this KnowledgeAnswerDocumentsResponse.
+ :type: KnowledgeAnswerGenerationResponse
+ """
+
+
+ self._answer_generation = answer_generation
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/knowledge_base_with_dialect_reference.py b/build/PureCloudPlatformClientV2/models/knowledge_base_with_dialect_reference.py
new file mode 100644
index 000000000..4aaa8b9f5
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/knowledge_base_with_dialect_reference.py
@@ -0,0 +1,198 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+
+class KnowledgeBaseWithDialectReference(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ KnowledgeBaseWithDialectReference - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'id': 'str',
+ 'language_code': 'str',
+ 'self_uri': 'str'
+ }
+
+ self.attribute_map = {
+ 'id': 'id',
+ 'language_code': 'languageCode',
+ 'self_uri': 'selfUri'
+ }
+
+ self._id = None
+ self._language_code = None
+ self._self_uri = None
+
+ @property
+ def id(self) -> str:
+ """
+ Gets the id of this KnowledgeBaseWithDialectReference.
+ The globally unique identifier for the knowledge base.
+
+ :return: The id of this KnowledgeBaseWithDialectReference.
+ :rtype: str
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id: str) -> None:
+ """
+ Sets the id of this KnowledgeBaseWithDialectReference.
+ The globally unique identifier for the knowledge base.
+
+ :param id: The id of this KnowledgeBaseWithDialectReference.
+ :type: str
+ """
+
+
+ self._id = id
+
+ @property
+ def language_code(self) -> str:
+ """
+ Gets the language_code of this KnowledgeBaseWithDialectReference.
+ The dialect for the knowledge base.
+
+ :return: The language_code of this KnowledgeBaseWithDialectReference.
+ :rtype: str
+ """
+ return self._language_code
+
+ @language_code.setter
+ def language_code(self, language_code: str) -> None:
+ """
+ Sets the language_code of this KnowledgeBaseWithDialectReference.
+ The dialect for the knowledge base.
+
+ :param language_code: The language_code of this KnowledgeBaseWithDialectReference.
+ :type: str
+ """
+ if isinstance(language_code, int):
+ language_code = str(language_code)
+ allowed_values = ["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"]
+ if language_code.lower() not in map(str.lower, allowed_values):
+ # print("Invalid value for language_code -> " + language_code)
+ self._language_code = "outdated_sdk_version"
+ else:
+ self._language_code = language_code
+
+ @property
+ def self_uri(self) -> str:
+ """
+ Gets the self_uri of this KnowledgeBaseWithDialectReference.
+ The URI for this object
+
+ :return: The self_uri of this KnowledgeBaseWithDialectReference.
+ :rtype: str
+ """
+ return self._self_uri
+
+ @self_uri.setter
+ def self_uri(self, self_uri: str) -> None:
+ """
+ Sets the self_uri of this KnowledgeBaseWithDialectReference.
+ The URI for this object
+
+ :param self_uri: The self_uri of this KnowledgeBaseWithDialectReference.
+ :type: str
+ """
+
+
+ self._self_uri = self_uri
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/knowledge_document_feedback_update_request.py b/build/PureCloudPlatformClientV2/models/knowledge_document_feedback_update_request.py
new file mode 100644
index 000000000..35ce190c7
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/knowledge_document_feedback_update_request.py
@@ -0,0 +1,235 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+
+class KnowledgeDocumentFeedbackUpdateRequest(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ KnowledgeDocumentFeedbackUpdateRequest - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'rating': 'str',
+ 'reason': 'str',
+ 'comment': 'str',
+ 'state': 'str'
+ }
+
+ self.attribute_map = {
+ 'rating': 'rating',
+ 'reason': 'reason',
+ 'comment': 'comment',
+ 'state': 'state'
+ }
+
+ self._rating = None
+ self._reason = None
+ self._comment = None
+ self._state = None
+
+ @property
+ def rating(self) -> str:
+ """
+ Gets the rating of this KnowledgeDocumentFeedbackUpdateRequest.
+ Feedback rating.
+
+ :return: The rating of this KnowledgeDocumentFeedbackUpdateRequest.
+ :rtype: str
+ """
+ return self._rating
+
+ @rating.setter
+ def rating(self, rating: str) -> None:
+ """
+ Sets the rating of this KnowledgeDocumentFeedbackUpdateRequest.
+ Feedback rating.
+
+ :param rating: The rating of this KnowledgeDocumentFeedbackUpdateRequest.
+ :type: str
+ """
+ if isinstance(rating, int):
+ rating = str(rating)
+ allowed_values = ["Negative", "Positive"]
+ if rating.lower() not in map(str.lower, allowed_values):
+ # print("Invalid value for rating -> " + rating)
+ self._rating = "outdated_sdk_version"
+ else:
+ self._rating = rating
+
+ @property
+ def reason(self) -> str:
+ """
+ Gets the reason of this KnowledgeDocumentFeedbackUpdateRequest.
+ Feedback reason
+
+ :return: The reason of this KnowledgeDocumentFeedbackUpdateRequest.
+ :rtype: str
+ """
+ return self._reason
+
+ @reason.setter
+ def reason(self, reason: str) -> None:
+ """
+ Sets the reason of this KnowledgeDocumentFeedbackUpdateRequest.
+ Feedback reason
+
+ :param reason: The reason of this KnowledgeDocumentFeedbackUpdateRequest.
+ :type: str
+ """
+ if isinstance(reason, int):
+ reason = str(reason)
+ allowed_values = ["DocumentContent", "SearchResults"]
+ if reason.lower() not in map(str.lower, allowed_values):
+ # print("Invalid value for reason -> " + reason)
+ self._reason = "outdated_sdk_version"
+ else:
+ self._reason = reason
+
+ @property
+ def comment(self) -> str:
+ """
+ Gets the comment of this KnowledgeDocumentFeedbackUpdateRequest.
+ Feedback comment
+
+ :return: The comment of this KnowledgeDocumentFeedbackUpdateRequest.
+ :rtype: str
+ """
+ return self._comment
+
+ @comment.setter
+ def comment(self, comment: str) -> None:
+ """
+ Sets the comment of this KnowledgeDocumentFeedbackUpdateRequest.
+ Feedback comment
+
+ :param comment: The comment of this KnowledgeDocumentFeedbackUpdateRequest.
+ :type: str
+ """
+
+
+ self._comment = comment
+
+ @property
+ def state(self) -> str:
+ """
+ Gets the state of this KnowledgeDocumentFeedbackUpdateRequest.
+ Feedback state
+
+ :return: The state of this KnowledgeDocumentFeedbackUpdateRequest.
+ :rtype: str
+ """
+ return self._state
+
+ @state.setter
+ def state(self, state: str) -> None:
+ """
+ Sets the state of this KnowledgeDocumentFeedbackUpdateRequest.
+ Feedback state
+
+ :param state: The state of this KnowledgeDocumentFeedbackUpdateRequest.
+ :type: str
+ """
+ if isinstance(state, int):
+ state = str(state)
+ allowed_values = ["Draft", "Final"]
+ if state.lower() not in map(str.lower, allowed_values):
+ # print("Invalid value for state -> " + state)
+ self._state = "outdated_sdk_version"
+ else:
+ self._state = state
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/knowledge_documents_answer_filter.py b/build/PureCloudPlatformClientV2/models/knowledge_documents_answer_filter.py
new file mode 100644
index 000000000..4ae9228cf
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/knowledge_documents_answer_filter.py
@@ -0,0 +1,343 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+
+class KnowledgeDocumentsAnswerFilter(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ KnowledgeDocumentsAnswerFilter - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'query': 'str',
+ 'language': 'str',
+ 'app_type': 'str',
+ 'query_type': 'str',
+ 'search_id': 'str',
+ 'insert_highlight_into_variation_content': 'bool',
+ 'answer_mode': 'list[str]',
+ 'variation_ids': 'list[str]'
+ }
+
+ self.attribute_map = {
+ 'query': 'query',
+ 'language': 'language',
+ 'app_type': 'appType',
+ 'query_type': 'queryType',
+ 'search_id': 'searchId',
+ 'insert_highlight_into_variation_content': 'insertHighlightIntoVariationContent',
+ 'answer_mode': 'answerMode',
+ 'variation_ids': 'variationIds'
+ }
+
+ self._query = None
+ self._language = None
+ self._app_type = None
+ self._query_type = None
+ self._search_id = None
+ self._insert_highlight_into_variation_content = None
+ self._answer_mode = None
+ self._variation_ids = None
+
+ @property
+ def query(self) -> str:
+ """
+ Gets the query of this KnowledgeDocumentsAnswerFilter.
+ The search query.
+
+ :return: The query of this KnowledgeDocumentsAnswerFilter.
+ :rtype: str
+ """
+ return self._query
+
+ @query.setter
+ def query(self, query: str) -> None:
+ """
+ Sets the query of this KnowledgeDocumentsAnswerFilter.
+ The search query.
+
+ :param query: The query of this KnowledgeDocumentsAnswerFilter.
+ :type: str
+ """
+
+
+ self._query = query
+
+ @property
+ def language(self) -> str:
+ """
+ Gets the language of this KnowledgeDocumentsAnswerFilter.
+ The language of the documents.
+
+ :return: The language of this KnowledgeDocumentsAnswerFilter.
+ :rtype: str
+ """
+ return self._language
+
+ @language.setter
+ def language(self, language: str) -> None:
+ """
+ Sets the language of this KnowledgeDocumentsAnswerFilter.
+ The language of the documents.
+
+ :param language: The language of this KnowledgeDocumentsAnswerFilter.
+ :type: str
+ """
+ if isinstance(language, int):
+ language = str(language)
+ allowed_values = ["en-US", "en-UK", "en-AU", "en-CA", "en-HK", "en-IN", "en-IE", "en-NZ", "en-PH", "en-SG", "en-ZA", "de-DE", "de-AT", "de-CH", "es-AR", "es-CO", "es-MX", "es-US", "es-ES", "fr-FR", "fr-BE", "fr-CA", "fr-CH", "pt-BR", "pt-PT", "nl-NL", "nl-BE", "it-IT", "ca-ES", "tr-TR", "sv-SE", "fi-FI", "nb-NO", "da-DK", "ja-JP", "ar-AE", "zh-CN", "zh-TW", "zh-HK", "ko-KR", "pl-PL", "hi-IN", "th-TH", "hu-HU", "vi-VN", "uk-UA"]
+ if language.lower() not in map(str.lower, allowed_values):
+ # print("Invalid value for language -> " + language)
+ self._language = "outdated_sdk_version"
+ else:
+ self._language = language
+
+ @property
+ def app_type(self) -> str:
+ """
+ Gets the app_type of this KnowledgeDocumentsAnswerFilter.
+ The appType
+
+ :return: The app_type of this KnowledgeDocumentsAnswerFilter.
+ :rtype: str
+ """
+ return self._app_type
+
+ @app_type.setter
+ def app_type(self, app_type: str) -> None:
+ """
+ Sets the app_type of this KnowledgeDocumentsAnswerFilter.
+ The appType
+
+ :param app_type: The app_type of this KnowledgeDocumentsAnswerFilter.
+ :type: str
+ """
+ if isinstance(app_type, int):
+ app_type = str(app_type)
+ allowed_values = ["Assistant", "BotFlow", "MessengerKnowledgeApp", "SmartAdvisor", "SupportCenter"]
+ if app_type.lower() not in map(str.lower, allowed_values):
+ # print("Invalid value for app_type -> " + app_type)
+ self._app_type = "outdated_sdk_version"
+ else:
+ self._app_type = app_type
+
+ @property
+ def query_type(self) -> str:
+ """
+ Gets the query_type of this KnowledgeDocumentsAnswerFilter.
+ The query type
+
+ :return: The query_type of this KnowledgeDocumentsAnswerFilter.
+ :rtype: str
+ """
+ return self._query_type
+
+ @query_type.setter
+ def query_type(self, query_type: str) -> None:
+ """
+ Sets the query_type of this KnowledgeDocumentsAnswerFilter.
+ The query type
+
+ :param query_type: The query_type of this KnowledgeDocumentsAnswerFilter.
+ :type: str
+ """
+ if isinstance(query_type, int):
+ query_type = str(query_type)
+ allowed_values = ["Unknown", "Article", "AutoSearch", "Category", "ManualSearch", "Recommendation", "Suggestion"]
+ if query_type.lower() not in map(str.lower, allowed_values):
+ # print("Invalid value for query_type -> " + query_type)
+ self._query_type = "outdated_sdk_version"
+ else:
+ self._query_type = query_type
+
+ @property
+ def search_id(self) -> str:
+ """
+ Gets the search_id of this KnowledgeDocumentsAnswerFilter.
+ The search id.
+
+ :return: The search_id of this KnowledgeDocumentsAnswerFilter.
+ :rtype: str
+ """
+ return self._search_id
+
+ @search_id.setter
+ def search_id(self, search_id: str) -> None:
+ """
+ Sets the search_id of this KnowledgeDocumentsAnswerFilter.
+ The search id.
+
+ :param search_id: The search_id of this KnowledgeDocumentsAnswerFilter.
+ :type: str
+ """
+
+
+ self._search_id = search_id
+
+ @property
+ def insert_highlight_into_variation_content(self) -> bool:
+ """
+ Gets the insert_highlight_into_variation_content of this KnowledgeDocumentsAnswerFilter.
+ If specified - insert highlight data into the variation content.
+
+ :return: The insert_highlight_into_variation_content of this KnowledgeDocumentsAnswerFilter.
+ :rtype: bool
+ """
+ return self._insert_highlight_into_variation_content
+
+ @insert_highlight_into_variation_content.setter
+ def insert_highlight_into_variation_content(self, insert_highlight_into_variation_content: bool) -> None:
+ """
+ Sets the insert_highlight_into_variation_content of this KnowledgeDocumentsAnswerFilter.
+ If specified - insert highlight data into the variation content.
+
+ :param insert_highlight_into_variation_content: The insert_highlight_into_variation_content of this KnowledgeDocumentsAnswerFilter.
+ :type: bool
+ """
+
+
+ self._insert_highlight_into_variation_content = insert_highlight_into_variation_content
+
+ @property
+ def answer_mode(self) -> List[str]:
+ """
+ Gets the answer_mode of this KnowledgeDocumentsAnswerFilter.
+ Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration). Default mode: AnswerHighlight
+
+ :return: The answer_mode of this KnowledgeDocumentsAnswerFilter.
+ :rtype: list[str]
+ """
+ return self._answer_mode
+
+ @answer_mode.setter
+ def answer_mode(self, answer_mode: List[str]) -> None:
+ """
+ Sets the answer_mode of this KnowledgeDocumentsAnswerFilter.
+ Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration). Default mode: AnswerHighlight
+
+ :param answer_mode: The answer_mode of this KnowledgeDocumentsAnswerFilter.
+ :type: list[str]
+ """
+
+
+ self._answer_mode = answer_mode
+
+ @property
+ def variation_ids(self) -> List[str]:
+ """
+ Gets the variation_ids of this KnowledgeDocumentsAnswerFilter.
+ The variation Ids to answer.
+
+ :return: The variation_ids of this KnowledgeDocumentsAnswerFilter.
+ :rtype: list[str]
+ """
+ return self._variation_ids
+
+ @variation_ids.setter
+ def variation_ids(self, variation_ids: List[str]) -> None:
+ """
+ Sets the variation_ids of this KnowledgeDocumentsAnswerFilter.
+ The variation Ids to answer.
+
+ :param variation_ids: The variation_ids of this KnowledgeDocumentsAnswerFilter.
+ :type: list[str]
+ """
+
+
+ self._variation_ids = variation_ids
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/knowledge_guest_answer_document_response.py b/build/PureCloudPlatformClientV2/models/knowledge_guest_answer_document_response.py
new file mode 100644
index 000000000..ef7cd6667
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/knowledge_guest_answer_document_response.py
@@ -0,0 +1,222 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import KnowledgeGuestDocumentVariationAnswer
+
+class KnowledgeGuestAnswerDocumentResponse(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ KnowledgeGuestAnswerDocumentResponse - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'id': 'str',
+ 'title': 'str',
+ 'answer': 'str',
+ 'variation': 'KnowledgeGuestDocumentVariationAnswer'
+ }
+
+ self.attribute_map = {
+ 'id': 'id',
+ 'title': 'title',
+ 'answer': 'answer',
+ 'variation': 'variation'
+ }
+
+ self._id = None
+ self._title = None
+ self._answer = None
+ self._variation = None
+
+ @property
+ def id(self) -> str:
+ """
+ Gets the id of this KnowledgeGuestAnswerDocumentResponse.
+ The document id.
+
+ :return: The id of this KnowledgeGuestAnswerDocumentResponse.
+ :rtype: str
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id: str) -> None:
+ """
+ Sets the id of this KnowledgeGuestAnswerDocumentResponse.
+ The document id.
+
+ :param id: The id of this KnowledgeGuestAnswerDocumentResponse.
+ :type: str
+ """
+
+
+ self._id = id
+
+ @property
+ def title(self) -> str:
+ """
+ Gets the title of this KnowledgeGuestAnswerDocumentResponse.
+ The document title.
+
+ :return: The title of this KnowledgeGuestAnswerDocumentResponse.
+ :rtype: str
+ """
+ return self._title
+
+ @title.setter
+ def title(self, title: str) -> None:
+ """
+ Sets the title of this KnowledgeGuestAnswerDocumentResponse.
+ The document title.
+
+ :param title: The title of this KnowledgeGuestAnswerDocumentResponse.
+ :type: str
+ """
+
+
+ self._title = title
+
+ @property
+ def answer(self) -> str:
+ """
+ Gets the answer of this KnowledgeGuestAnswerDocumentResponse.
+ The answer found inside a variationContent.
+
+ :return: The answer of this KnowledgeGuestAnswerDocumentResponse.
+ :rtype: str
+ """
+ return self._answer
+
+ @answer.setter
+ def answer(self, answer: str) -> None:
+ """
+ Sets the answer of this KnowledgeGuestAnswerDocumentResponse.
+ The answer found inside a variationContent.
+
+ :param answer: The answer of this KnowledgeGuestAnswerDocumentResponse.
+ :type: str
+ """
+
+
+ self._answer = answer
+
+ @property
+ def variation(self) -> 'KnowledgeGuestDocumentVariationAnswer':
+ """
+ Gets the variation of this KnowledgeGuestAnswerDocumentResponse.
+ The variation with the answer's highlight data.
+
+ :return: The variation of this KnowledgeGuestAnswerDocumentResponse.
+ :rtype: KnowledgeGuestDocumentVariationAnswer
+ """
+ return self._variation
+
+ @variation.setter
+ def variation(self, variation: 'KnowledgeGuestDocumentVariationAnswer') -> None:
+ """
+ Sets the variation of this KnowledgeGuestAnswerDocumentResponse.
+ The variation with the answer's highlight data.
+
+ :param variation: The variation of this KnowledgeGuestAnswerDocumentResponse.
+ :type: KnowledgeGuestDocumentVariationAnswer
+ """
+
+
+ self._variation = variation
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/knowledge_guest_answer_documents_response.py b/build/PureCloudPlatformClientV2/models/knowledge_guest_answer_documents_response.py
new file mode 100644
index 000000000..9de44aa33
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/knowledge_guest_answer_documents_response.py
@@ -0,0 +1,141 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import KnowledgeGuestAnswerDocumentResponse
+
+class KnowledgeGuestAnswerDocumentsResponse(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ KnowledgeGuestAnswerDocumentsResponse - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'results': 'list[KnowledgeGuestAnswerDocumentResponse]'
+ }
+
+ self.attribute_map = {
+ 'results': 'results'
+ }
+
+ self._results = None
+
+ @property
+ def results(self) -> List['KnowledgeGuestAnswerDocumentResponse']:
+ """
+ Gets the results of this KnowledgeGuestAnswerDocumentsResponse.
+ The results with answers.
+
+ :return: The results of this KnowledgeGuestAnswerDocumentsResponse.
+ :rtype: list[KnowledgeGuestAnswerDocumentResponse]
+ """
+ return self._results
+
+ @results.setter
+ def results(self, results: List['KnowledgeGuestAnswerDocumentResponse']) -> None:
+ """
+ Sets the results of this KnowledgeGuestAnswerDocumentsResponse.
+ The results with answers.
+
+ :param results: The results of this KnowledgeGuestAnswerDocumentsResponse.
+ :type: list[KnowledgeGuestAnswerDocumentResponse]
+ """
+
+
+ self._results = results
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/knowledge_suggestion_config.py b/build/PureCloudPlatformClientV2/models/knowledge_suggestion_config.py
new file mode 100644
index 000000000..f7d6c536d
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/knowledge_suggestion_config.py
@@ -0,0 +1,201 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import KnowledgeBaseReference
+ from . import KnowledgeBaseWithDialectReference
+
+class KnowledgeSuggestionConfig(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ KnowledgeSuggestionConfig - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'vendor_name': 'str',
+ 'knowledge_base': 'KnowledgeBaseReference',
+ 'knowledge_bases': 'list[KnowledgeBaseWithDialectReference]'
+ }
+
+ self.attribute_map = {
+ 'vendor_name': 'vendorName',
+ 'knowledge_base': 'knowledgeBase',
+ 'knowledge_bases': 'knowledgeBases'
+ }
+
+ self._vendor_name = None
+ self._knowledge_base = None
+ self._knowledge_bases = None
+
+ @property
+ def vendor_name(self) -> str:
+ """
+ Gets the vendor_name of this KnowledgeSuggestionConfig.
+ The name of vendor used for knowledge suggestions.
+
+ :return: The vendor_name of this KnowledgeSuggestionConfig.
+ :rtype: str
+ """
+ return self._vendor_name
+
+ @vendor_name.setter
+ def vendor_name(self, vendor_name: str) -> None:
+ """
+ Sets the vendor_name of this KnowledgeSuggestionConfig.
+ The name of vendor used for knowledge suggestions.
+
+ :param vendor_name: The vendor_name of this KnowledgeSuggestionConfig.
+ :type: str
+ """
+ if isinstance(vendor_name, int):
+ vendor_name = str(vendor_name)
+ allowed_values = ["GoogleDialogflow", "GenesysKnowledge", "Unknown"]
+ if vendor_name.lower() not in map(str.lower, allowed_values):
+ # print("Invalid value for vendor_name -> " + vendor_name)
+ self._vendor_name = "outdated_sdk_version"
+ else:
+ self._vendor_name = vendor_name
+
+ @property
+ def knowledge_base(self) -> 'KnowledgeBaseReference':
+ """
+ Gets the knowledge_base of this KnowledgeSuggestionConfig.
+ The ID of knowledge base to query when Genesys is the knowledge suggestions provider.
+
+ :return: The knowledge_base of this KnowledgeSuggestionConfig.
+ :rtype: KnowledgeBaseReference
+ """
+ return self._knowledge_base
+
+ @knowledge_base.setter
+ def knowledge_base(self, knowledge_base: 'KnowledgeBaseReference') -> None:
+ """
+ Sets the knowledge_base of this KnowledgeSuggestionConfig.
+ The ID of knowledge base to query when Genesys is the knowledge suggestions provider.
+
+ :param knowledge_base: The knowledge_base of this KnowledgeSuggestionConfig.
+ :type: KnowledgeBaseReference
+ """
+
+
+ self._knowledge_base = knowledge_base
+
+ @property
+ def knowledge_bases(self) -> List['KnowledgeBaseWithDialectReference']:
+ """
+ Gets the knowledge_bases of this KnowledgeSuggestionConfig.
+ The knowledge bases to query based on dialect, when Genesys is the knowledge suggestions provider.
+
+ :return: The knowledge_bases of this KnowledgeSuggestionConfig.
+ :rtype: list[KnowledgeBaseWithDialectReference]
+ """
+ return self._knowledge_bases
+
+ @knowledge_bases.setter
+ def knowledge_bases(self, knowledge_bases: List['KnowledgeBaseWithDialectReference']) -> None:
+ """
+ Sets the knowledge_bases of this KnowledgeSuggestionConfig.
+ The knowledge bases to query based on dialect, when Genesys is the knowledge suggestions provider.
+
+ :param knowledge_bases: The knowledge_bases of this KnowledgeSuggestionConfig.
+ :type: list[KnowledgeBaseWithDialectReference]
+ """
+
+
+ self._knowledge_bases = knowledge_bases
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/language_entity_listing.py b/build/PureCloudPlatformClientV2/models/language_entity_listing.py
index e9cd10562..f14ea2691 100644
--- a/build/PureCloudPlatformClientV2/models/language_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/language_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this LanguageEntityListing.
+ Gets the first_uri of this LanguageEntityListing.
- :return: The last_uri of this LanguageEntityListing.
+ :return: The first_uri of this LanguageEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this LanguageEntityListing.
+ Sets the first_uri of this LanguageEntityListing.
- :param last_uri: The last_uri of this LanguageEntityListing.
+ :param first_uri: The first_uri of this LanguageEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this LanguageEntityListing.
+ Gets the last_uri of this LanguageEntityListing.
- :return: The first_uri of this LanguageEntityListing.
+ :return: The last_uri of this LanguageEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this LanguageEntityListing.
+ Sets the last_uri of this LanguageEntityListing.
- :param first_uri: The first_uri of this LanguageEntityListing.
+ :param last_uri: The last_uri of this LanguageEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/learning_assignment_user_listing.py b/build/PureCloudPlatformClientV2/models/learning_assignment_user_listing.py
index a733623d2..4d64ac2c0 100644
--- a/build/PureCloudPlatformClientV2/models/learning_assignment_user_listing.py
+++ b/build/PureCloudPlatformClientV2/models/learning_assignment_user_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'unfiltered_total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'unfiltered_total': 'unfilteredTotal',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._unfiltered_total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def unfiltered_total(self, unfiltered_total: int) -> None:
self._unfiltered_total = unfiltered_total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this LearningAssignmentUserListing.
+ Gets the first_uri of this LearningAssignmentUserListing.
- :return: The last_uri of this LearningAssignmentUserListing.
+ :return: The first_uri of this LearningAssignmentUserListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this LearningAssignmentUserListing.
+ Sets the first_uri of this LearningAssignmentUserListing.
- :param last_uri: The last_uri of this LearningAssignmentUserListing.
+ :param first_uri: The first_uri of this LearningAssignmentUserListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this LearningAssignmentUserListing.
+ Gets the last_uri of this LearningAssignmentUserListing.
- :return: The first_uri of this LearningAssignmentUserListing.
+ :return: The last_uri of this LearningAssignmentUserListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this LearningAssignmentUserListing.
+ Sets the last_uri of this LearningAssignmentUserListing.
- :param first_uri: The first_uri of this LearningAssignmentUserListing.
+ :param last_uri: The last_uri of this LearningAssignmentUserListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/learning_assignments_domain_entity.py b/build/PureCloudPlatformClientV2/models/learning_assignments_domain_entity.py
index 081e00096..462074856 100644
--- a/build/PureCloudPlatformClientV2/models/learning_assignments_domain_entity.py
+++ b/build/PureCloudPlatformClientV2/models/learning_assignments_domain_entity.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this LearningAssignmentsDomainEntity.
+ Gets the first_uri of this LearningAssignmentsDomainEntity.
- :return: The last_uri of this LearningAssignmentsDomainEntity.
+ :return: The first_uri of this LearningAssignmentsDomainEntity.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this LearningAssignmentsDomainEntity.
+ Sets the first_uri of this LearningAssignmentsDomainEntity.
- :param last_uri: The last_uri of this LearningAssignmentsDomainEntity.
+ :param first_uri: The first_uri of this LearningAssignmentsDomainEntity.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this LearningAssignmentsDomainEntity.
+ Gets the last_uri of this LearningAssignmentsDomainEntity.
- :return: The first_uri of this LearningAssignmentsDomainEntity.
+ :return: The last_uri of this LearningAssignmentsDomainEntity.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this LearningAssignmentsDomainEntity.
+ Sets the last_uri of this LearningAssignmentsDomainEntity.
- :param first_uri: The first_uri of this LearningAssignmentsDomainEntity.
+ :param last_uri: The last_uri of this LearningAssignmentsDomainEntity.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/learning_modules_domain_entity_listing.py b/build/PureCloudPlatformClientV2/models/learning_modules_domain_entity_listing.py
index c17b34184..9bf4d1661 100644
--- a/build/PureCloudPlatformClientV2/models/learning_modules_domain_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/learning_modules_domain_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this LearningModulesDomainEntityListing.
+ Gets the first_uri of this LearningModulesDomainEntityListing.
- :return: The last_uri of this LearningModulesDomainEntityListing.
+ :return: The first_uri of this LearningModulesDomainEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this LearningModulesDomainEntityListing.
+ Sets the first_uri of this LearningModulesDomainEntityListing.
- :param last_uri: The last_uri of this LearningModulesDomainEntityListing.
+ :param first_uri: The first_uri of this LearningModulesDomainEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this LearningModulesDomainEntityListing.
+ Gets the last_uri of this LearningModulesDomainEntityListing.
- :return: The first_uri of this LearningModulesDomainEntityListing.
+ :return: The last_uri of this LearningModulesDomainEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this LearningModulesDomainEntityListing.
+ Sets the last_uri of this LearningModulesDomainEntityListing.
- :param first_uri: The first_uri of this LearningModulesDomainEntityListing.
+ :param last_uri: The last_uri of this LearningModulesDomainEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/lex_bot_alias_entity_listing.py b/build/PureCloudPlatformClientV2/models/lex_bot_alias_entity_listing.py
index e1ecb8e40..81a02ac92 100644
--- a/build/PureCloudPlatformClientV2/models/lex_bot_alias_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/lex_bot_alias_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this LexBotAliasEntityListing.
+ Gets the first_uri of this LexBotAliasEntityListing.
- :return: The last_uri of this LexBotAliasEntityListing.
+ :return: The first_uri of this LexBotAliasEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this LexBotAliasEntityListing.
+ Sets the first_uri of this LexBotAliasEntityListing.
- :param last_uri: The last_uri of this LexBotAliasEntityListing.
+ :param first_uri: The first_uri of this LexBotAliasEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this LexBotAliasEntityListing.
+ Gets the last_uri of this LexBotAliasEntityListing.
- :return: The first_uri of this LexBotAliasEntityListing.
+ :return: The last_uri of this LexBotAliasEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this LexBotAliasEntityListing.
+ Sets the last_uri of this LexBotAliasEntityListing.
- :param first_uri: The first_uri of this LexBotAliasEntityListing.
+ :param last_uri: The last_uri of this LexBotAliasEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/lex_bot_entity_listing.py b/build/PureCloudPlatformClientV2/models/lex_bot_entity_listing.py
index 7c20d54d3..658f35363 100644
--- a/build/PureCloudPlatformClientV2/models/lex_bot_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/lex_bot_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this LexBotEntityListing.
+ Gets the first_uri of this LexBotEntityListing.
- :return: The last_uri of this LexBotEntityListing.
+ :return: The first_uri of this LexBotEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this LexBotEntityListing.
+ Sets the first_uri of this LexBotEntityListing.
- :param last_uri: The last_uri of this LexBotEntityListing.
+ :param first_uri: The first_uri of this LexBotEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this LexBotEntityListing.
+ Gets the last_uri of this LexBotEntityListing.
- :return: The first_uri of this LexBotEntityListing.
+ :return: The last_uri of this LexBotEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this LexBotEntityListing.
+ Sets the last_uri of this LexBotEntityListing.
- :param first_uri: The first_uri of this LexBotEntityListing.
+ :param last_uri: The last_uri of this LexBotEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/lex_v2_bot_alias_entity_listing.py b/build/PureCloudPlatformClientV2/models/lex_v2_bot_alias_entity_listing.py
index 2cb261286..557cef36f 100644
--- a/build/PureCloudPlatformClientV2/models/lex_v2_bot_alias_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/lex_v2_bot_alias_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this LexV2BotAliasEntityListing.
+ Gets the first_uri of this LexV2BotAliasEntityListing.
- :return: The last_uri of this LexV2BotAliasEntityListing.
+ :return: The first_uri of this LexV2BotAliasEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this LexV2BotAliasEntityListing.
+ Sets the first_uri of this LexV2BotAliasEntityListing.
- :param last_uri: The last_uri of this LexV2BotAliasEntityListing.
+ :param first_uri: The first_uri of this LexV2BotAliasEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this LexV2BotAliasEntityListing.
+ Gets the last_uri of this LexV2BotAliasEntityListing.
- :return: The first_uri of this LexV2BotAliasEntityListing.
+ :return: The last_uri of this LexV2BotAliasEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this LexV2BotAliasEntityListing.
+ Sets the last_uri of this LexV2BotAliasEntityListing.
- :param first_uri: The first_uri of this LexV2BotAliasEntityListing.
+ :param last_uri: The last_uri of this LexV2BotAliasEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/lex_v2_bot_entity_listing.py b/build/PureCloudPlatformClientV2/models/lex_v2_bot_entity_listing.py
index cce781d0e..fd16bc0de 100644
--- a/build/PureCloudPlatformClientV2/models/lex_v2_bot_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/lex_v2_bot_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this LexV2BotEntityListing.
+ Gets the first_uri of this LexV2BotEntityListing.
- :return: The last_uri of this LexV2BotEntityListing.
+ :return: The first_uri of this LexV2BotEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this LexV2BotEntityListing.
+ Sets the first_uri of this LexV2BotEntityListing.
- :param last_uri: The last_uri of this LexV2BotEntityListing.
+ :param first_uri: The first_uri of this LexV2BotEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this LexV2BotEntityListing.
+ Gets the last_uri of this LexV2BotEntityListing.
- :return: The first_uri of this LexV2BotEntityListing.
+ :return: The last_uri of this LexV2BotEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this LexV2BotEntityListing.
+ Sets the last_uri of this LexV2BotEntityListing.
- :param first_uri: The first_uri of this LexV2BotEntityListing.
+ :param last_uri: The last_uri of this LexV2BotEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/library_entity_listing.py b/build/PureCloudPlatformClientV2/models/library_entity_listing.py
index c0ef3f36a..d73236bf4 100644
--- a/build/PureCloudPlatformClientV2/models/library_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/library_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this LibraryEntityListing.
+ Gets the first_uri of this LibraryEntityListing.
- :return: The last_uri of this LibraryEntityListing.
+ :return: The first_uri of this LibraryEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this LibraryEntityListing.
+ Sets the first_uri of this LibraryEntityListing.
- :param last_uri: The last_uri of this LibraryEntityListing.
+ :param first_uri: The first_uri of this LibraryEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this LibraryEntityListing.
+ Gets the last_uri of this LibraryEntityListing.
- :return: The first_uri of this LibraryEntityListing.
+ :return: The last_uri of this LibraryEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this LibraryEntityListing.
+ Sets the last_uri of this LibraryEntityListing.
- :param first_uri: The first_uri of this LibraryEntityListing.
+ :param last_uri: The last_uri of this LibraryEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/line_base_entity_listing.py b/build/PureCloudPlatformClientV2/models/line_base_entity_listing.py
index 618fd792c..ac8b35db9 100644
--- a/build/PureCloudPlatformClientV2/models/line_base_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/line_base_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this LineBaseEntityListing.
+ Gets the first_uri of this LineBaseEntityListing.
- :return: The last_uri of this LineBaseEntityListing.
+ :return: The first_uri of this LineBaseEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this LineBaseEntityListing.
+ Sets the first_uri of this LineBaseEntityListing.
- :param last_uri: The last_uri of this LineBaseEntityListing.
+ :param first_uri: The first_uri of this LineBaseEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this LineBaseEntityListing.
+ Gets the last_uri of this LineBaseEntityListing.
- :return: The first_uri of this LineBaseEntityListing.
+ :return: The last_uri of this LineBaseEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this LineBaseEntityListing.
+ Sets the last_uri of this LineBaseEntityListing.
- :param first_uri: The first_uri of this LineBaseEntityListing.
+ :param last_uri: The last_uri of this LineBaseEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/line_entity_listing.py b/build/PureCloudPlatformClientV2/models/line_entity_listing.py
index 4ab901eca..4b81fb17f 100644
--- a/build/PureCloudPlatformClientV2/models/line_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/line_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this LineEntityListing.
+ Gets the first_uri of this LineEntityListing.
- :return: The last_uri of this LineEntityListing.
+ :return: The first_uri of this LineEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this LineEntityListing.
+ Sets the first_uri of this LineEntityListing.
- :param last_uri: The last_uri of this LineEntityListing.
+ :param first_uri: The first_uri of this LineEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this LineEntityListing.
+ Gets the last_uri of this LineEntityListing.
- :return: The first_uri of this LineEntityListing.
+ :return: The last_uri of this LineEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this LineEntityListing.
+ Sets the last_uri of this LineEntityListing.
- :param first_uri: The first_uri of this LineEntityListing.
+ :param last_uri: The last_uri of this LineEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/location_entity_listing.py b/build/PureCloudPlatformClientV2/models/location_entity_listing.py
index aeb862942..91bef6094 100644
--- a/build/PureCloudPlatformClientV2/models/location_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/location_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this LocationEntityListing.
+ Gets the first_uri of this LocationEntityListing.
- :return: The last_uri of this LocationEntityListing.
+ :return: The first_uri of this LocationEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this LocationEntityListing.
+ Sets the first_uri of this LocationEntityListing.
- :param last_uri: The last_uri of this LocationEntityListing.
+ :param first_uri: The first_uri of this LocationEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this LocationEntityListing.
+ Gets the last_uri of this LocationEntityListing.
- :return: The first_uri of this LocationEntityListing.
+ :return: The last_uri of this LocationEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this LocationEntityListing.
+ Sets the last_uri of this LocationEntityListing.
- :param first_uri: The first_uri of this LocationEntityListing.
+ :param last_uri: The last_uri of this LocationEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/logical_interface_entity_listing.py b/build/PureCloudPlatformClientV2/models/logical_interface_entity_listing.py
index 1e091c752..5b015a3be 100644
--- a/build/PureCloudPlatformClientV2/models/logical_interface_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/logical_interface_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this LogicalInterfaceEntityListing.
+ Gets the first_uri of this LogicalInterfaceEntityListing.
- :return: The last_uri of this LogicalInterfaceEntityListing.
+ :return: The first_uri of this LogicalInterfaceEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this LogicalInterfaceEntityListing.
+ Sets the first_uri of this LogicalInterfaceEntityListing.
- :param last_uri: The last_uri of this LogicalInterfaceEntityListing.
+ :param first_uri: The first_uri of this LogicalInterfaceEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this LogicalInterfaceEntityListing.
+ Gets the last_uri of this LogicalInterfaceEntityListing.
- :return: The first_uri of this LogicalInterfaceEntityListing.
+ :return: The last_uri of this LogicalInterfaceEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this LogicalInterfaceEntityListing.
+ Sets the last_uri of this LogicalInterfaceEntityListing.
- :param first_uri: The first_uri of this LogicalInterfaceEntityListing.
+ :param last_uri: The last_uri of this LogicalInterfaceEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/management_unit_listing.py b/build/PureCloudPlatformClientV2/models/management_unit_listing.py
index 45f3c34f8..b1354bc3c 100644
--- a/build/PureCloudPlatformClientV2/models/management_unit_listing.py
+++ b/build/PureCloudPlatformClientV2/models/management_unit_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'next_uri': 'str',
'page_count': 'int',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'next_uri': 'nextUri',
'page_count': 'pageCount',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._next_uri = None
self._page_count = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ManagementUnitListing.
+ Gets the first_uri of this ManagementUnitListing.
Deprecated, paging is not supported
- :return: The last_uri of this ManagementUnitListing.
+ :return: The first_uri of this ManagementUnitListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ManagementUnitListing.
+ Sets the first_uri of this ManagementUnitListing.
Deprecated, paging is not supported
- :param last_uri: The last_uri of this ManagementUnitListing.
+ :param first_uri: The first_uri of this ManagementUnitListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ManagementUnitListing.
+ Gets the last_uri of this ManagementUnitListing.
Deprecated, paging is not supported
- :return: The first_uri of this ManagementUnitListing.
+ :return: The last_uri of this ManagementUnitListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ManagementUnitListing.
+ Sets the last_uri of this ManagementUnitListing.
Deprecated, paging is not supported
- :param first_uri: The first_uri of this ManagementUnitListing.
+ :param last_uri: The last_uri of this ManagementUnitListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def next_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/message_conversation_entity_listing.py b/build/PureCloudPlatformClientV2/models/message_conversation_entity_listing.py
index 142e0ece0..c6d1c1b3d 100644
--- a/build/PureCloudPlatformClientV2/models/message_conversation_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/message_conversation_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this MessageConversationEntityListing.
+ Gets the first_uri of this MessageConversationEntityListing.
- :return: The last_uri of this MessageConversationEntityListing.
+ :return: The first_uri of this MessageConversationEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this MessageConversationEntityListing.
+ Sets the first_uri of this MessageConversationEntityListing.
- :param last_uri: The last_uri of this MessageConversationEntityListing.
+ :param first_uri: The first_uri of this MessageConversationEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this MessageConversationEntityListing.
+ Gets the last_uri of this MessageConversationEntityListing.
- :return: The first_uri of this MessageConversationEntityListing.
+ :return: The last_uri of this MessageConversationEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this MessageConversationEntityListing.
+ Sets the last_uri of this MessageConversationEntityListing.
- :param first_uri: The first_uri of this MessageConversationEntityListing.
+ :param last_uri: The last_uri of this MessageConversationEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/messaging_campaign_division_view_entity_listing.py b/build/PureCloudPlatformClientV2/models/messaging_campaign_division_view_entity_listing.py
index cf14ceb8c..8f3478b90 100644
--- a/build/PureCloudPlatformClientV2/models/messaging_campaign_division_view_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/messaging_campaign_division_view_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this MessagingCampaignDivisionViewEntityListing.
+ Gets the first_uri of this MessagingCampaignDivisionViewEntityListing.
- :return: The last_uri of this MessagingCampaignDivisionViewEntityListing.
+ :return: The first_uri of this MessagingCampaignDivisionViewEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this MessagingCampaignDivisionViewEntityListing.
+ Sets the first_uri of this MessagingCampaignDivisionViewEntityListing.
- :param last_uri: The last_uri of this MessagingCampaignDivisionViewEntityListing.
+ :param first_uri: The first_uri of this MessagingCampaignDivisionViewEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this MessagingCampaignDivisionViewEntityListing.
+ Gets the last_uri of this MessagingCampaignDivisionViewEntityListing.
- :return: The first_uri of this MessagingCampaignDivisionViewEntityListing.
+ :return: The last_uri of this MessagingCampaignDivisionViewEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this MessagingCampaignDivisionViewEntityListing.
+ Sets the last_uri of this MessagingCampaignDivisionViewEntityListing.
- :param first_uri: The first_uri of this MessagingCampaignDivisionViewEntityListing.
+ :param last_uri: The last_uri of this MessagingCampaignDivisionViewEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/messaging_campaign_entity_listing.py b/build/PureCloudPlatformClientV2/models/messaging_campaign_entity_listing.py
index 877430b91..ce25d683b 100644
--- a/build/PureCloudPlatformClientV2/models/messaging_campaign_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/messaging_campaign_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this MessagingCampaignEntityListing.
+ Gets the first_uri of this MessagingCampaignEntityListing.
- :return: The last_uri of this MessagingCampaignEntityListing.
+ :return: The first_uri of this MessagingCampaignEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this MessagingCampaignEntityListing.
+ Sets the first_uri of this MessagingCampaignEntityListing.
- :param last_uri: The last_uri of this MessagingCampaignEntityListing.
+ :param first_uri: The first_uri of this MessagingCampaignEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this MessagingCampaignEntityListing.
+ Gets the last_uri of this MessagingCampaignEntityListing.
- :return: The first_uri of this MessagingCampaignEntityListing.
+ :return: The last_uri of this MessagingCampaignEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this MessagingCampaignEntityListing.
+ Sets the last_uri of this MessagingCampaignEntityListing.
- :param first_uri: The first_uri of this MessagingCampaignEntityListing.
+ :param last_uri: The last_uri of this MessagingCampaignEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/messaging_campaign_schedule_entity_listing.py b/build/PureCloudPlatformClientV2/models/messaging_campaign_schedule_entity_listing.py
index 5a2a8e3ac..c7aac7c87 100644
--- a/build/PureCloudPlatformClientV2/models/messaging_campaign_schedule_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/messaging_campaign_schedule_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this MessagingCampaignScheduleEntityListing.
+ Gets the first_uri of this MessagingCampaignScheduleEntityListing.
- :return: The last_uri of this MessagingCampaignScheduleEntityListing.
+ :return: The first_uri of this MessagingCampaignScheduleEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this MessagingCampaignScheduleEntityListing.
+ Sets the first_uri of this MessagingCampaignScheduleEntityListing.
- :param last_uri: The last_uri of this MessagingCampaignScheduleEntityListing.
+ :param first_uri: The first_uri of this MessagingCampaignScheduleEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this MessagingCampaignScheduleEntityListing.
+ Gets the last_uri of this MessagingCampaignScheduleEntityListing.
- :return: The first_uri of this MessagingCampaignScheduleEntityListing.
+ :return: The last_uri of this MessagingCampaignScheduleEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this MessagingCampaignScheduleEntityListing.
+ Sets the last_uri of this MessagingCampaignScheduleEntityListing.
- :param first_uri: The first_uri of this MessagingCampaignScheduleEntityListing.
+ :param last_uri: The last_uri of this MessagingCampaignScheduleEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/messaging_config_listing.py b/build/PureCloudPlatformClientV2/models/messaging_config_listing.py
index 1199ff6ad..a9acc457b 100644
--- a/build/PureCloudPlatformClientV2/models/messaging_config_listing.py
+++ b/build/PureCloudPlatformClientV2/models/messaging_config_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this MessagingConfigListing.
+ Gets the first_uri of this MessagingConfigListing.
- :return: The last_uri of this MessagingConfigListing.
+ :return: The first_uri of this MessagingConfigListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this MessagingConfigListing.
+ Sets the first_uri of this MessagingConfigListing.
- :param last_uri: The last_uri of this MessagingConfigListing.
+ :param first_uri: The first_uri of this MessagingConfigListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this MessagingConfigListing.
+ Gets the last_uri of this MessagingConfigListing.
- :return: The first_uri of this MessagingConfigListing.
+ :return: The last_uri of this MessagingConfigListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this MessagingConfigListing.
+ Sets the last_uri of this MessagingConfigListing.
- :param first_uri: The first_uri of this MessagingConfigListing.
+ :param last_uri: The last_uri of this MessagingConfigListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/messaging_integration_entity_listing.py b/build/PureCloudPlatformClientV2/models/messaging_integration_entity_listing.py
index 50273fa4e..de6922a9f 100644
--- a/build/PureCloudPlatformClientV2/models/messaging_integration_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/messaging_integration_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this MessagingIntegrationEntityListing.
+ Gets the first_uri of this MessagingIntegrationEntityListing.
- :return: The last_uri of this MessagingIntegrationEntityListing.
+ :return: The first_uri of this MessagingIntegrationEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this MessagingIntegrationEntityListing.
+ Sets the first_uri of this MessagingIntegrationEntityListing.
- :param last_uri: The last_uri of this MessagingIntegrationEntityListing.
+ :param first_uri: The first_uri of this MessagingIntegrationEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this MessagingIntegrationEntityListing.
+ Gets the last_uri of this MessagingIntegrationEntityListing.
- :return: The first_uri of this MessagingIntegrationEntityListing.
+ :return: The last_uri of this MessagingIntegrationEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this MessagingIntegrationEntityListing.
+ Sets the last_uri of this MessagingIntegrationEntityListing.
- :param first_uri: The first_uri of this MessagingIntegrationEntityListing.
+ :param last_uri: The last_uri of this MessagingIntegrationEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/nlu_config.py b/build/PureCloudPlatformClientV2/models/nlu_config.py
new file mode 100644
index 000000000..60d9e8ab2
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/nlu_config.py
@@ -0,0 +1,168 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import CopilotNluDomain
+
+class NluConfig(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ NluConfig - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'domain': 'CopilotNluDomain',
+ 'intent_confidence_threshold': 'float'
+ }
+
+ self.attribute_map = {
+ 'domain': 'domain',
+ 'intent_confidence_threshold': 'intentConfidenceThreshold'
+ }
+
+ self._domain = None
+ self._intent_confidence_threshold = None
+
+ @property
+ def domain(self) -> 'CopilotNluDomain':
+ """
+ Gets the domain of this NluConfig.
+ NLU domain.
+
+ :return: The domain of this NluConfig.
+ :rtype: CopilotNluDomain
+ """
+ return self._domain
+
+ @domain.setter
+ def domain(self, domain: 'CopilotNluDomain') -> None:
+ """
+ Sets the domain of this NluConfig.
+ NLU domain.
+
+ :param domain: The domain of this NluConfig.
+ :type: CopilotNluDomain
+ """
+
+
+ self._domain = domain
+
+ @property
+ def intent_confidence_threshold(self) -> float:
+ """
+ Gets the intent_confidence_threshold of this NluConfig.
+ Minimum confidence value of accepting NLU intents, must be greater than 0 and less than 1.
+
+ :return: The intent_confidence_threshold of this NluConfig.
+ :rtype: float
+ """
+ return self._intent_confidence_threshold
+
+ @intent_confidence_threshold.setter
+ def intent_confidence_threshold(self, intent_confidence_threshold: float) -> None:
+ """
+ Sets the intent_confidence_threshold of this NluConfig.
+ Minimum confidence value of accepting NLU intents, must be greater than 0 and less than 1.
+
+ :param intent_confidence_threshold: The intent_confidence_threshold of this NluConfig.
+ :type: float
+ """
+
+
+ self._intent_confidence_threshold = intent_confidence_threshold
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/nlu_domain_listing.py b/build/PureCloudPlatformClientV2/models/nlu_domain_listing.py
index d1931318e..bbaa5cec5 100644
--- a/build/PureCloudPlatformClientV2/models/nlu_domain_listing.py
+++ b/build/PureCloudPlatformClientV2/models/nlu_domain_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this NluDomainListing.
+ Gets the first_uri of this NluDomainListing.
- :return: The last_uri of this NluDomainListing.
+ :return: The first_uri of this NluDomainListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this NluDomainListing.
+ Sets the first_uri of this NluDomainListing.
- :param last_uri: The last_uri of this NluDomainListing.
+ :param first_uri: The first_uri of this NluDomainListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this NluDomainListing.
+ Gets the last_uri of this NluDomainListing.
- :return: The first_uri of this NluDomainListing.
+ :return: The last_uri of this NluDomainListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this NluDomainListing.
+ Sets the last_uri of this NluDomainListing.
- :param first_uri: The first_uri of this NluDomainListing.
+ :param last_uri: The last_uri of this NluDomainListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/nlu_domain_version_listing.py b/build/PureCloudPlatformClientV2/models/nlu_domain_version_listing.py
index 32fc83354..db11b28a2 100644
--- a/build/PureCloudPlatformClientV2/models/nlu_domain_version_listing.py
+++ b/build/PureCloudPlatformClientV2/models/nlu_domain_version_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this NluDomainVersionListing.
+ Gets the first_uri of this NluDomainVersionListing.
- :return: The last_uri of this NluDomainVersionListing.
+ :return: The first_uri of this NluDomainVersionListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this NluDomainVersionListing.
+ Sets the first_uri of this NluDomainVersionListing.
- :param last_uri: The last_uri of this NluDomainVersionListing.
+ :param first_uri: The first_uri of this NluDomainVersionListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this NluDomainVersionListing.
+ Gets the last_uri of this NluDomainVersionListing.
- :return: The first_uri of this NluDomainVersionListing.
+ :return: The last_uri of this NluDomainVersionListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this NluDomainVersionListing.
+ Sets the last_uri of this NluDomainVersionListing.
- :param first_uri: The first_uri of this NluDomainVersionListing.
+ :param last_uri: The last_uri of this NluDomainVersionListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/nlu_feedback_listing.py b/build/PureCloudPlatformClientV2/models/nlu_feedback_listing.py
index 35dbdd1ac..9b3b7b8f3 100644
--- a/build/PureCloudPlatformClientV2/models/nlu_feedback_listing.py
+++ b/build/PureCloudPlatformClientV2/models/nlu_feedback_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this NluFeedbackListing.
+ Gets the first_uri of this NluFeedbackListing.
- :return: The last_uri of this NluFeedbackListing.
+ :return: The first_uri of this NluFeedbackListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this NluFeedbackListing.
+ Sets the first_uri of this NluFeedbackListing.
- :param last_uri: The last_uri of this NluFeedbackListing.
+ :param first_uri: The first_uri of this NluFeedbackListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this NluFeedbackListing.
+ Gets the last_uri of this NluFeedbackListing.
- :return: The first_uri of this NluFeedbackListing.
+ :return: The last_uri of this NluFeedbackListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this NluFeedbackListing.
+ Sets the last_uri of this NluFeedbackListing.
- :param first_uri: The first_uri of this NluFeedbackListing.
+ :param last_uri: The last_uri of this NluFeedbackListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/note_listing.py b/build/PureCloudPlatformClientV2/models/note_listing.py
index 4b911403b..59d7b75a4 100644
--- a/build/PureCloudPlatformClientV2/models/note_listing.py
+++ b/build/PureCloudPlatformClientV2/models/note_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'partial_results': 'bool',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'partial_results': 'partialResults',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._partial_results = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def partial_results(self, partial_results: bool) -> None:
self._partial_results = partial_results
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this NoteListing.
+ Gets the first_uri of this NoteListing.
- :return: The last_uri of this NoteListing.
+ :return: The first_uri of this NoteListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this NoteListing.
+ Sets the first_uri of this NoteListing.
- :param last_uri: The last_uri of this NoteListing.
+ :param first_uri: The first_uri of this NoteListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this NoteListing.
+ Gets the last_uri of this NoteListing.
- :return: The first_uri of this NoteListing.
+ :return: The last_uri of this NoteListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this NoteListing.
+ Sets the last_uri of this NoteListing.
- :param first_uri: The first_uri of this NoteListing.
+ :param last_uri: The last_uri of this NoteListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/nuance_bot_entity_listing.py b/build/PureCloudPlatformClientV2/models/nuance_bot_entity_listing.py
index 396a6bf00..14e5ae639 100644
--- a/build/PureCloudPlatformClientV2/models/nuance_bot_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/nuance_bot_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this NuanceBotEntityListing.
+ Gets the first_uri of this NuanceBotEntityListing.
- :return: The last_uri of this NuanceBotEntityListing.
+ :return: The first_uri of this NuanceBotEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this NuanceBotEntityListing.
+ Sets the first_uri of this NuanceBotEntityListing.
- :param last_uri: The last_uri of this NuanceBotEntityListing.
+ :param first_uri: The first_uri of this NuanceBotEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this NuanceBotEntityListing.
+ Gets the last_uri of this NuanceBotEntityListing.
- :return: The first_uri of this NuanceBotEntityListing.
+ :return: The last_uri of this NuanceBotEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this NuanceBotEntityListing.
+ Sets the last_uri of this NuanceBotEntityListing.
- :param first_uri: The first_uri of this NuanceBotEntityListing.
+ :param last_uri: The last_uri of this NuanceBotEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/o_auth_client_entity_listing.py b/build/PureCloudPlatformClientV2/models/o_auth_client_entity_listing.py
index 35ae6a37b..7dcb1bcfa 100644
--- a/build/PureCloudPlatformClientV2/models/o_auth_client_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/o_auth_client_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this OAuthClientEntityListing.
+ Gets the first_uri of this OAuthClientEntityListing.
- :return: The last_uri of this OAuthClientEntityListing.
+ :return: The first_uri of this OAuthClientEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this OAuthClientEntityListing.
+ Sets the first_uri of this OAuthClientEntityListing.
- :param last_uri: The last_uri of this OAuthClientEntityListing.
+ :param first_uri: The first_uri of this OAuthClientEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this OAuthClientEntityListing.
+ Gets the last_uri of this OAuthClientEntityListing.
- :return: The first_uri of this OAuthClientEntityListing.
+ :return: The last_uri of this OAuthClientEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this OAuthClientEntityListing.
+ Sets the last_uri of this OAuthClientEntityListing.
- :param first_uri: The first_uri of this OAuthClientEntityListing.
+ :param last_uri: The last_uri of this OAuthClientEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/open_integration_entity_listing.py b/build/PureCloudPlatformClientV2/models/open_integration_entity_listing.py
index 47672d89c..08ea94bf8 100644
--- a/build/PureCloudPlatformClientV2/models/open_integration_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/open_integration_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this OpenIntegrationEntityListing.
+ Gets the first_uri of this OpenIntegrationEntityListing.
- :return: The last_uri of this OpenIntegrationEntityListing.
+ :return: The first_uri of this OpenIntegrationEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this OpenIntegrationEntityListing.
+ Sets the first_uri of this OpenIntegrationEntityListing.
- :param last_uri: The last_uri of this OpenIntegrationEntityListing.
+ :param first_uri: The first_uri of this OpenIntegrationEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this OpenIntegrationEntityListing.
+ Gets the last_uri of this OpenIntegrationEntityListing.
- :return: The first_uri of this OpenIntegrationEntityListing.
+ :return: The last_uri of this OpenIntegrationEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this OpenIntegrationEntityListing.
+ Sets the last_uri of this OpenIntegrationEntityListing.
- :param first_uri: The first_uri of this OpenIntegrationEntityListing.
+ :param last_uri: The last_uri of this OpenIntegrationEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/organization_presence_entity_listing.py b/build/PureCloudPlatformClientV2/models/organization_presence_entity_listing.py
index f2084987b..d96fac0fb 100644
--- a/build/PureCloudPlatformClientV2/models/organization_presence_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/organization_presence_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this OrganizationPresenceEntityListing.
+ Gets the first_uri of this OrganizationPresenceEntityListing.
- :return: The last_uri of this OrganizationPresenceEntityListing.
+ :return: The first_uri of this OrganizationPresenceEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this OrganizationPresenceEntityListing.
+ Sets the first_uri of this OrganizationPresenceEntityListing.
- :param last_uri: The last_uri of this OrganizationPresenceEntityListing.
+ :param first_uri: The first_uri of this OrganizationPresenceEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this OrganizationPresenceEntityListing.
+ Gets the last_uri of this OrganizationPresenceEntityListing.
- :return: The first_uri of this OrganizationPresenceEntityListing.
+ :return: The last_uri of this OrganizationPresenceEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this OrganizationPresenceEntityListing.
+ Sets the last_uri of this OrganizationPresenceEntityListing.
- :param first_uri: The first_uri of this OrganizationPresenceEntityListing.
+ :param last_uri: The last_uri of this OrganizationPresenceEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/organization_role_entity_listing.py b/build/PureCloudPlatformClientV2/models/organization_role_entity_listing.py
index 84f597bfd..ec199742f 100644
--- a/build/PureCloudPlatformClientV2/models/organization_role_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/organization_role_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this OrganizationRoleEntityListing.
+ Gets the first_uri of this OrganizationRoleEntityListing.
- :return: The last_uri of this OrganizationRoleEntityListing.
+ :return: The first_uri of this OrganizationRoleEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this OrganizationRoleEntityListing.
+ Sets the first_uri of this OrganizationRoleEntityListing.
- :param last_uri: The last_uri of this OrganizationRoleEntityListing.
+ :param first_uri: The first_uri of this OrganizationRoleEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this OrganizationRoleEntityListing.
+ Gets the last_uri of this OrganizationRoleEntityListing.
- :return: The first_uri of this OrganizationRoleEntityListing.
+ :return: The last_uri of this OrganizationRoleEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this OrganizationRoleEntityListing.
+ Sets the last_uri of this OrganizationRoleEntityListing.
- :param first_uri: The first_uri of this OrganizationRoleEntityListing.
+ :param last_uri: The last_uri of this OrganizationRoleEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/orphan_recording_listing.py b/build/PureCloudPlatformClientV2/models/orphan_recording_listing.py
index 3cf7f64ad..796328e19 100644
--- a/build/PureCloudPlatformClientV2/models/orphan_recording_listing.py
+++ b/build/PureCloudPlatformClientV2/models/orphan_recording_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this OrphanRecordingListing.
+ Gets the first_uri of this OrphanRecordingListing.
- :return: The last_uri of this OrphanRecordingListing.
+ :return: The first_uri of this OrphanRecordingListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this OrphanRecordingListing.
+ Sets the first_uri of this OrphanRecordingListing.
- :param last_uri: The last_uri of this OrphanRecordingListing.
+ :param first_uri: The first_uri of this OrphanRecordingListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this OrphanRecordingListing.
+ Gets the last_uri of this OrphanRecordingListing.
- :return: The first_uri of this OrphanRecordingListing.
+ :return: The last_uri of this OrphanRecordingListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this OrphanRecordingListing.
+ Sets the last_uri of this OrphanRecordingListing.
- :param first_uri: The first_uri of this OrphanRecordingListing.
+ :param last_uri: The last_uri of this OrphanRecordingListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/outbound_detail_event_topic_outbound_init_event.py b/build/PureCloudPlatformClientV2/models/outbound_detail_event_topic_outbound_init_event.py
index 0f3d9514b..8d807a878 100644
--- a/build/PureCloudPlatformClientV2/models/outbound_detail_event_topic_outbound_init_event.py
+++ b/build/PureCloudPlatformClientV2/models/outbound_detail_event_topic_outbound_init_event.py
@@ -431,7 +431,7 @@ def message_type(self, message_type: str) -> None:
"""
if isinstance(message_type, int):
message_type = str(message_type)
- allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM"]
+ allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM", "APPLE"]
if message_type.lower() not in map(str.lower, allowed_values):
# print("Invalid value for message_type -> " + message_type)
self._message_type = "outdated_sdk_version"
diff --git a/build/PureCloudPlatformClientV2/models/outbound_domain_entity_listing.py b/build/PureCloudPlatformClientV2/models/outbound_domain_entity_listing.py
index e69084057..a131c88ce 100644
--- a/build/PureCloudPlatformClientV2/models/outbound_domain_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/outbound_domain_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this OutboundDomainEntityListing.
+ Gets the first_uri of this OutboundDomainEntityListing.
- :return: The last_uri of this OutboundDomainEntityListing.
+ :return: The first_uri of this OutboundDomainEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this OutboundDomainEntityListing.
+ Sets the first_uri of this OutboundDomainEntityListing.
- :param last_uri: The last_uri of this OutboundDomainEntityListing.
+ :param first_uri: The first_uri of this OutboundDomainEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this OutboundDomainEntityListing.
+ Gets the last_uri of this OutboundDomainEntityListing.
- :return: The first_uri of this OutboundDomainEntityListing.
+ :return: The last_uri of this OutboundDomainEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this OutboundDomainEntityListing.
+ Sets the last_uri of this OutboundDomainEntityListing.
- :param first_uri: The first_uri of this OutboundDomainEntityListing.
+ :param last_uri: The last_uri of this OutboundDomainEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/outbound_route_base_entity_listing.py b/build/PureCloudPlatformClientV2/models/outbound_route_base_entity_listing.py
index 304651be1..bbc26a501 100644
--- a/build/PureCloudPlatformClientV2/models/outbound_route_base_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/outbound_route_base_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this OutboundRouteBaseEntityListing.
+ Gets the first_uri of this OutboundRouteBaseEntityListing.
- :return: The last_uri of this OutboundRouteBaseEntityListing.
+ :return: The first_uri of this OutboundRouteBaseEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this OutboundRouteBaseEntityListing.
+ Sets the first_uri of this OutboundRouteBaseEntityListing.
- :param last_uri: The last_uri of this OutboundRouteBaseEntityListing.
+ :param first_uri: The first_uri of this OutboundRouteBaseEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this OutboundRouteBaseEntityListing.
+ Gets the last_uri of this OutboundRouteBaseEntityListing.
- :return: The first_uri of this OutboundRouteBaseEntityListing.
+ :return: The last_uri of this OutboundRouteBaseEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this OutboundRouteBaseEntityListing.
+ Sets the last_uri of this OutboundRouteBaseEntityListing.
- :param first_uri: The first_uri of this OutboundRouteBaseEntityListing.
+ :param last_uri: The last_uri of this OutboundRouteBaseEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/outbound_route_entity_listing.py b/build/PureCloudPlatformClientV2/models/outbound_route_entity_listing.py
index 9b9691132..6d270bd24 100644
--- a/build/PureCloudPlatformClientV2/models/outbound_route_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/outbound_route_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this OutboundRouteEntityListing.
+ Gets the first_uri of this OutboundRouteEntityListing.
- :return: The last_uri of this OutboundRouteEntityListing.
+ :return: The first_uri of this OutboundRouteEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this OutboundRouteEntityListing.
+ Sets the first_uri of this OutboundRouteEntityListing.
- :param last_uri: The last_uri of this OutboundRouteEntityListing.
+ :param first_uri: The first_uri of this OutboundRouteEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this OutboundRouteEntityListing.
+ Gets the last_uri of this OutboundRouteEntityListing.
- :return: The first_uri of this OutboundRouteEntityListing.
+ :return: The last_uri of this OutboundRouteEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this OutboundRouteEntityListing.
+ Sets the last_uri of this OutboundRouteEntityListing.
- :param first_uri: The first_uri of this OutboundRouteEntityListing.
+ :param last_uri: The last_uri of this OutboundRouteEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/outcome_listing.py b/build/PureCloudPlatformClientV2/models/outcome_listing.py
index ebf9af69c..3fc0d303e 100644
--- a/build/PureCloudPlatformClientV2/models/outcome_listing.py
+++ b/build/PureCloudPlatformClientV2/models/outcome_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this OutcomeListing.
+ Gets the first_uri of this OutcomeListing.
- :return: The last_uri of this OutcomeListing.
+ :return: The first_uri of this OutcomeListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this OutcomeListing.
+ Sets the first_uri of this OutcomeListing.
- :param last_uri: The last_uri of this OutcomeListing.
+ :param first_uri: The first_uri of this OutcomeListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this OutcomeListing.
+ Gets the last_uri of this OutcomeListing.
- :return: The first_uri of this OutcomeListing.
+ :return: The last_uri of this OutcomeListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this OutcomeListing.
+ Sets the last_uri of this OutcomeListing.
- :param first_uri: The first_uri of this OutcomeListing.
+ :param last_uri: The last_uri of this OutcomeListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/permission_collection_entity_listing.py b/build/PureCloudPlatformClientV2/models/permission_collection_entity_listing.py
index b3f319a50..4464d5399 100644
--- a/build/PureCloudPlatformClientV2/models/permission_collection_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/permission_collection_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this PermissionCollectionEntityListing.
+ Gets the first_uri of this PermissionCollectionEntityListing.
- :return: The last_uri of this PermissionCollectionEntityListing.
+ :return: The first_uri of this PermissionCollectionEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this PermissionCollectionEntityListing.
+ Sets the first_uri of this PermissionCollectionEntityListing.
- :param last_uri: The last_uri of this PermissionCollectionEntityListing.
+ :param first_uri: The first_uri of this PermissionCollectionEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this PermissionCollectionEntityListing.
+ Gets the last_uri of this PermissionCollectionEntityListing.
- :return: The first_uri of this PermissionCollectionEntityListing.
+ :return: The last_uri of this PermissionCollectionEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this PermissionCollectionEntityListing.
+ Sets the last_uri of this PermissionCollectionEntityListing.
- :param first_uri: The first_uri of this PermissionCollectionEntityListing.
+ :param last_uri: The last_uri of this PermissionCollectionEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/phone_base_entity_listing.py b/build/PureCloudPlatformClientV2/models/phone_base_entity_listing.py
index 0bb91e45d..3aa5c381f 100644
--- a/build/PureCloudPlatformClientV2/models/phone_base_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/phone_base_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this PhoneBaseEntityListing.
+ Gets the first_uri of this PhoneBaseEntityListing.
- :return: The last_uri of this PhoneBaseEntityListing.
+ :return: The first_uri of this PhoneBaseEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this PhoneBaseEntityListing.
+ Sets the first_uri of this PhoneBaseEntityListing.
- :param last_uri: The last_uri of this PhoneBaseEntityListing.
+ :param first_uri: The first_uri of this PhoneBaseEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this PhoneBaseEntityListing.
+ Gets the last_uri of this PhoneBaseEntityListing.
- :return: The first_uri of this PhoneBaseEntityListing.
+ :return: The last_uri of this PhoneBaseEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this PhoneBaseEntityListing.
+ Sets the last_uri of this PhoneBaseEntityListing.
- :param first_uri: The first_uri of this PhoneBaseEntityListing.
+ :param last_uri: The last_uri of this PhoneBaseEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/phone_entity_listing.py b/build/PureCloudPlatformClientV2/models/phone_entity_listing.py
index c440d1b7d..eae687feb 100644
--- a/build/PureCloudPlatformClientV2/models/phone_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/phone_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this PhoneEntityListing.
+ Gets the first_uri of this PhoneEntityListing.
- :return: The last_uri of this PhoneEntityListing.
+ :return: The first_uri of this PhoneEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this PhoneEntityListing.
+ Sets the first_uri of this PhoneEntityListing.
- :param last_uri: The last_uri of this PhoneEntityListing.
+ :param first_uri: The first_uri of this PhoneEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this PhoneEntityListing.
+ Gets the last_uri of this PhoneEntityListing.
- :return: The first_uri of this PhoneEntityListing.
+ :return: The last_uri of this PhoneEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this PhoneEntityListing.
+ Sets the last_uri of this PhoneEntityListing.
- :param first_uri: The first_uri of this PhoneEntityListing.
+ :param last_uri: The last_uri of this PhoneEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/phone_meta_base_entity_listing.py b/build/PureCloudPlatformClientV2/models/phone_meta_base_entity_listing.py
index ad2d5731f..116e84cf4 100644
--- a/build/PureCloudPlatformClientV2/models/phone_meta_base_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/phone_meta_base_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this PhoneMetaBaseEntityListing.
+ Gets the first_uri of this PhoneMetaBaseEntityListing.
- :return: The last_uri of this PhoneMetaBaseEntityListing.
+ :return: The first_uri of this PhoneMetaBaseEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this PhoneMetaBaseEntityListing.
+ Sets the first_uri of this PhoneMetaBaseEntityListing.
- :param last_uri: The last_uri of this PhoneMetaBaseEntityListing.
+ :param first_uri: The first_uri of this PhoneMetaBaseEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this PhoneMetaBaseEntityListing.
+ Gets the last_uri of this PhoneMetaBaseEntityListing.
- :return: The first_uri of this PhoneMetaBaseEntityListing.
+ :return: The last_uri of this PhoneMetaBaseEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this PhoneMetaBaseEntityListing.
+ Sets the last_uri of this PhoneMetaBaseEntityListing.
- :param first_uri: The first_uri of this PhoneMetaBaseEntityListing.
+ :param last_uri: The last_uri of this PhoneMetaBaseEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/physical_interface_entity_listing.py b/build/PureCloudPlatformClientV2/models/physical_interface_entity_listing.py
index 7d71955bf..c83cef566 100644
--- a/build/PureCloudPlatformClientV2/models/physical_interface_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/physical_interface_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this PhysicalInterfaceEntityListing.
+ Gets the first_uri of this PhysicalInterfaceEntityListing.
- :return: The last_uri of this PhysicalInterfaceEntityListing.
+ :return: The first_uri of this PhysicalInterfaceEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this PhysicalInterfaceEntityListing.
+ Sets the first_uri of this PhysicalInterfaceEntityListing.
- :param last_uri: The last_uri of this PhysicalInterfaceEntityListing.
+ :param first_uri: The first_uri of this PhysicalInterfaceEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this PhysicalInterfaceEntityListing.
+ Gets the last_uri of this PhysicalInterfaceEntityListing.
- :return: The first_uri of this PhysicalInterfaceEntityListing.
+ :return: The last_uri of this PhysicalInterfaceEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this PhysicalInterfaceEntityListing.
+ Sets the last_uri of this PhysicalInterfaceEntityListing.
- :param first_uri: The first_uri of this PhysicalInterfaceEntityListing.
+ :param last_uri: The last_uri of this PhysicalInterfaceEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/policy_entity_listing.py b/build/PureCloudPlatformClientV2/models/policy_entity_listing.py
index 7617e63d2..5d5e004b0 100644
--- a/build/PureCloudPlatformClientV2/models/policy_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/policy_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this PolicyEntityListing.
+ Gets the first_uri of this PolicyEntityListing.
- :return: The last_uri of this PolicyEntityListing.
+ :return: The first_uri of this PolicyEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this PolicyEntityListing.
+ Sets the first_uri of this PolicyEntityListing.
- :param last_uri: The last_uri of this PolicyEntityListing.
+ :param first_uri: The first_uri of this PolicyEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this PolicyEntityListing.
+ Gets the last_uri of this PolicyEntityListing.
- :return: The first_uri of this PolicyEntityListing.
+ :return: The last_uri of this PolicyEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this PolicyEntityListing.
+ Sets the last_uri of this PolicyEntityListing.
- :param first_uri: The first_uri of this PolicyEntityListing.
+ :param last_uri: The last_uri of this PolicyEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/prompt_asset_entity_listing.py b/build/PureCloudPlatformClientV2/models/prompt_asset_entity_listing.py
index d05dbaef9..c672fc2df 100644
--- a/build/PureCloudPlatformClientV2/models/prompt_asset_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/prompt_asset_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this PromptAssetEntityListing.
+ Gets the first_uri of this PromptAssetEntityListing.
- :return: The last_uri of this PromptAssetEntityListing.
+ :return: The first_uri of this PromptAssetEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this PromptAssetEntityListing.
+ Sets the first_uri of this PromptAssetEntityListing.
- :param last_uri: The last_uri of this PromptAssetEntityListing.
+ :param first_uri: The first_uri of this PromptAssetEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this PromptAssetEntityListing.
+ Gets the last_uri of this PromptAssetEntityListing.
- :return: The first_uri of this PromptAssetEntityListing.
+ :return: The last_uri of this PromptAssetEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this PromptAssetEntityListing.
+ Sets the last_uri of this PromptAssetEntityListing.
- :param first_uri: The first_uri of this PromptAssetEntityListing.
+ :param last_uri: The last_uri of this PromptAssetEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/prompt_entity_listing.py b/build/PureCloudPlatformClientV2/models/prompt_entity_listing.py
index 50b2e3848..27ef641e1 100644
--- a/build/PureCloudPlatformClientV2/models/prompt_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/prompt_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this PromptEntityListing.
+ Gets the first_uri of this PromptEntityListing.
- :return: The last_uri of this PromptEntityListing.
+ :return: The first_uri of this PromptEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this PromptEntityListing.
+ Sets the first_uri of this PromptEntityListing.
- :param last_uri: The last_uri of this PromptEntityListing.
+ :param first_uri: The first_uri of this PromptEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this PromptEntityListing.
+ Gets the last_uri of this PromptEntityListing.
- :return: The first_uri of this PromptEntityListing.
+ :return: The last_uri of this PromptEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this PromptEntityListing.
+ Sets the last_uri of this PromptEntityListing.
- :param first_uri: The first_uri of this PromptEntityListing.
+ :param last_uri: The last_uri of this PromptEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/queue_entity_listing.py b/build/PureCloudPlatformClientV2/models/queue_entity_listing.py
index 65137bad7..c71f8e984 100644
--- a/build/PureCloudPlatformClientV2/models/queue_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/queue_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this QueueEntityListing.
+ Gets the first_uri of this QueueEntityListing.
- :return: The last_uri of this QueueEntityListing.
+ :return: The first_uri of this QueueEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this QueueEntityListing.
+ Sets the first_uri of this QueueEntityListing.
- :param last_uri: The last_uri of this QueueEntityListing.
+ :param first_uri: The first_uri of this QueueEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this QueueEntityListing.
+ Gets the last_uri of this QueueEntityListing.
- :return: The first_uri of this QueueEntityListing.
+ :return: The last_uri of this QueueEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this QueueEntityListing.
+ Sets the last_uri of this QueueEntityListing.
- :param first_uri: The first_uri of this QueueEntityListing.
+ :param last_uri: The last_uri of this QueueEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/queue_member_entity_listing_v1.py b/build/PureCloudPlatformClientV2/models/queue_member_entity_listing_v1.py
index 6f9c367b2..172cdd3ce 100644
--- a/build/PureCloudPlatformClientV2/models/queue_member_entity_listing_v1.py
+++ b/build/PureCloudPlatformClientV2/models/queue_member_entity_listing_v1.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this QueueMemberEntityListingV1.
+ Gets the first_uri of this QueueMemberEntityListingV1.
- :return: The last_uri of this QueueMemberEntityListingV1.
+ :return: The first_uri of this QueueMemberEntityListingV1.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this QueueMemberEntityListingV1.
+ Sets the first_uri of this QueueMemberEntityListingV1.
- :param last_uri: The last_uri of this QueueMemberEntityListingV1.
+ :param first_uri: The first_uri of this QueueMemberEntityListingV1.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this QueueMemberEntityListingV1.
+ Gets the last_uri of this QueueMemberEntityListingV1.
- :return: The first_uri of this QueueMemberEntityListingV1.
+ :return: The last_uri of this QueueMemberEntityListingV1.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this QueueMemberEntityListingV1.
+ Sets the last_uri of this QueueMemberEntityListingV1.
- :param first_uri: The first_uri of this QueueMemberEntityListingV1.
+ :param last_uri: The last_uri of this QueueMemberEntityListingV1.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/recipient_listing.py b/build/PureCloudPlatformClientV2/models/recipient_listing.py
index be6957ff1..28a7d2865 100644
--- a/build/PureCloudPlatformClientV2/models/recipient_listing.py
+++ b/build/PureCloudPlatformClientV2/models/recipient_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this RecipientListing.
+ Gets the first_uri of this RecipientListing.
- :return: The last_uri of this RecipientListing.
+ :return: The first_uri of this RecipientListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this RecipientListing.
+ Sets the first_uri of this RecipientListing.
- :param last_uri: The last_uri of this RecipientListing.
+ :param first_uri: The first_uri of this RecipientListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this RecipientListing.
+ Gets the last_uri of this RecipientListing.
- :return: The first_uri of this RecipientListing.
+ :return: The last_uri of this RecipientListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this RecipientListing.
+ Sets the last_uri of this RecipientListing.
- :param first_uri: The first_uri of this RecipientListing.
+ :param last_uri: The last_uri of this RecipientListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/recording_job_entity_listing.py b/build/PureCloudPlatformClientV2/models/recording_job_entity_listing.py
index aedbd944f..22d6758fc 100644
--- a/build/PureCloudPlatformClientV2/models/recording_job_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/recording_job_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this RecordingJobEntityListing.
+ Gets the first_uri of this RecordingJobEntityListing.
- :return: The last_uri of this RecordingJobEntityListing.
+ :return: The first_uri of this RecordingJobEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this RecordingJobEntityListing.
+ Sets the first_uri of this RecordingJobEntityListing.
- :param last_uri: The last_uri of this RecordingJobEntityListing.
+ :param first_uri: The first_uri of this RecordingJobEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this RecordingJobEntityListing.
+ Gets the last_uri of this RecordingJobEntityListing.
- :return: The first_uri of this RecordingJobEntityListing.
+ :return: The last_uri of this RecordingJobEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this RecordingJobEntityListing.
+ Sets the last_uri of this RecordingJobEntityListing.
- :param first_uri: The first_uri of this RecordingJobEntityListing.
+ :param last_uri: The last_uri of this RecordingJobEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/relationship_listing.py b/build/PureCloudPlatformClientV2/models/relationship_listing.py
index dd9b1133d..c88175140 100644
--- a/build/PureCloudPlatformClientV2/models/relationship_listing.py
+++ b/build/PureCloudPlatformClientV2/models/relationship_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'partial_results': 'bool',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'partial_results': 'partialResults',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._partial_results = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def partial_results(self, partial_results: bool) -> None:
self._partial_results = partial_results
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this RelationshipListing.
+ Gets the first_uri of this RelationshipListing.
- :return: The last_uri of this RelationshipListing.
+ :return: The first_uri of this RelationshipListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this RelationshipListing.
+ Sets the first_uri of this RelationshipListing.
- :param last_uri: The last_uri of this RelationshipListing.
+ :param first_uri: The first_uri of this RelationshipListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this RelationshipListing.
+ Gets the last_uri of this RelationshipListing.
- :return: The first_uri of this RelationshipListing.
+ :return: The last_uri of this RelationshipListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this RelationshipListing.
+ Sets the last_uri of this RelationshipListing.
- :param first_uri: The first_uri of this RelationshipListing.
+ :param last_uri: The last_uri of this RelationshipListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/reporting_export_job_listing.py b/build/PureCloudPlatformClientV2/models/reporting_export_job_listing.py
index 1924c6d21..7b72a26a3 100644
--- a/build/PureCloudPlatformClientV2/models/reporting_export_job_listing.py
+++ b/build/PureCloudPlatformClientV2/models/reporting_export_job_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ReportingExportJobListing.
+ Gets the first_uri of this ReportingExportJobListing.
- :return: The last_uri of this ReportingExportJobListing.
+ :return: The first_uri of this ReportingExportJobListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ReportingExportJobListing.
+ Sets the first_uri of this ReportingExportJobListing.
- :param last_uri: The last_uri of this ReportingExportJobListing.
+ :param first_uri: The first_uri of this ReportingExportJobListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ReportingExportJobListing.
+ Gets the last_uri of this ReportingExportJobListing.
- :return: The first_uri of this ReportingExportJobListing.
+ :return: The last_uri of this ReportingExportJobListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ReportingExportJobListing.
+ Sets the last_uri of this ReportingExportJobListing.
- :param first_uri: The first_uri of this ReportingExportJobListing.
+ :param last_uri: The last_uri of this ReportingExportJobListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/reporting_export_job_request.py b/build/PureCloudPlatformClientV2/models/reporting_export_job_request.py
index 14787bdfa..a4b74e433 100644
--- a/build/PureCloudPlatformClientV2/models/reporting_export_job_request.py
+++ b/build/PureCloudPlatformClientV2/models/reporting_export_job_request.py
@@ -264,7 +264,7 @@ def view_type(self, view_type: str) -> None:
"""
if isinstance(view_type, int):
view_type = str(view_type)
- allowed_values = ["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"]
+ allowed_values = ["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"]
if view_type.lower() not in map(str.lower, allowed_values):
# print("Invalid value for view_type -> " + view_type)
self._view_type = "outdated_sdk_version"
diff --git a/build/PureCloudPlatformClientV2/models/reporting_export_job_response.py b/build/PureCloudPlatformClientV2/models/reporting_export_job_response.py
index 971e10692..95dfb6ddd 100644
--- a/build/PureCloudPlatformClientV2/models/reporting_export_job_response.py
+++ b/build/PureCloudPlatformClientV2/models/reporting_export_job_response.py
@@ -380,7 +380,7 @@ def view_type(self, view_type: str) -> None:
"""
if isinstance(view_type, int):
view_type = str(view_type)
- allowed_values = ["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"]
+ allowed_values = ["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"]
if view_type.lower() not in map(str.lower, allowed_values):
# print("Invalid value for view_type -> " + view_type)
self._view_type = "outdated_sdk_version"
diff --git a/build/PureCloudPlatformClientV2/models/reporting_export_metadata_job_listing.py b/build/PureCloudPlatformClientV2/models/reporting_export_metadata_job_listing.py
index ef55d720e..fce21adfe 100644
--- a/build/PureCloudPlatformClientV2/models/reporting_export_metadata_job_listing.py
+++ b/build/PureCloudPlatformClientV2/models/reporting_export_metadata_job_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ReportingExportMetadataJobListing.
+ Gets the first_uri of this ReportingExportMetadataJobListing.
- :return: The last_uri of this ReportingExportMetadataJobListing.
+ :return: The first_uri of this ReportingExportMetadataJobListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ReportingExportMetadataJobListing.
+ Sets the first_uri of this ReportingExportMetadataJobListing.
- :param last_uri: The last_uri of this ReportingExportMetadataJobListing.
+ :param first_uri: The first_uri of this ReportingExportMetadataJobListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ReportingExportMetadataJobListing.
+ Gets the last_uri of this ReportingExportMetadataJobListing.
- :return: The first_uri of this ReportingExportMetadataJobListing.
+ :return: The last_uri of this ReportingExportMetadataJobListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ReportingExportMetadataJobListing.
+ Sets the last_uri of this ReportingExportMetadataJobListing.
- :param first_uri: The first_uri of this ReportingExportMetadataJobListing.
+ :param last_uri: The last_uri of this ReportingExportMetadataJobListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/reporting_export_metadata_job_response.py b/build/PureCloudPlatformClientV2/models/reporting_export_metadata_job_response.py
index 3e27a697e..656aa6f24 100644
--- a/build/PureCloudPlatformClientV2/models/reporting_export_metadata_job_response.py
+++ b/build/PureCloudPlatformClientV2/models/reporting_export_metadata_job_response.py
@@ -154,7 +154,7 @@ def view_type(self, view_type: str) -> None:
"""
if isinstance(view_type, int):
view_type = str(view_type)
- allowed_values = ["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"]
+ allowed_values = ["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"]
if view_type.lower() not in map(str.lower, allowed_values):
# print("Invalid value for view_type -> " + view_type)
self._view_type = "outdated_sdk_version"
diff --git a/build/PureCloudPlatformClientV2/models/reporting_turn_action.py b/build/PureCloudPlatformClientV2/models/reporting_turn_action.py
index a788d73f4..70ce8f4b9 100644
--- a/build/PureCloudPlatformClientV2/models/reporting_turn_action.py
+++ b/build/PureCloudPlatformClientV2/models/reporting_turn_action.py
@@ -160,7 +160,7 @@ def action_type(self, action_type: str) -> None:
"""
if isinstance(action_type, int):
action_type = str(action_type)
- allowed_values = ["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", "Unknown"]
+ allowed_values = ["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"]
if action_type.lower() not in map(str.lower, allowed_values):
# print("Invalid value for action_type -> " + action_type)
self._action_type = "outdated_sdk_version"
diff --git a/build/PureCloudPlatformClientV2/models/response_entity_list.py b/build/PureCloudPlatformClientV2/models/response_entity_list.py
index 6febdd131..6746accc2 100644
--- a/build/PureCloudPlatformClientV2/models/response_entity_list.py
+++ b/build/PureCloudPlatformClientV2/models/response_entity_list.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ResponseEntityList.
+ Gets the first_uri of this ResponseEntityList.
- :return: The last_uri of this ResponseEntityList.
+ :return: The first_uri of this ResponseEntityList.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ResponseEntityList.
+ Sets the first_uri of this ResponseEntityList.
- :param last_uri: The last_uri of this ResponseEntityList.
+ :param first_uri: The first_uri of this ResponseEntityList.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ResponseEntityList.
+ Gets the last_uri of this ResponseEntityList.
- :return: The first_uri of this ResponseEntityList.
+ :return: The last_uri of this ResponseEntityList.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ResponseEntityList.
+ Sets the last_uri of this ResponseEntityList.
- :param first_uri: The first_uri of this ResponseEntityList.
+ :param last_uri: The last_uri of this ResponseEntityList.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/response_entity_listing.py b/build/PureCloudPlatformClientV2/models/response_entity_listing.py
index 189d7f239..fdb4244d7 100644
--- a/build/PureCloudPlatformClientV2/models/response_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/response_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ResponseEntityListing.
+ Gets the first_uri of this ResponseEntityListing.
- :return: The last_uri of this ResponseEntityListing.
+ :return: The first_uri of this ResponseEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ResponseEntityListing.
+ Sets the first_uri of this ResponseEntityListing.
- :param last_uri: The last_uri of this ResponseEntityListing.
+ :param first_uri: The first_uri of this ResponseEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ResponseEntityListing.
+ Gets the last_uri of this ResponseEntityListing.
- :return: The first_uri of this ResponseEntityListing.
+ :return: The last_uri of this ResponseEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ResponseEntityListing.
+ Sets the last_uri of this ResponseEntityListing.
- :param first_uri: The first_uri of this ResponseEntityListing.
+ :param last_uri: The last_uri of this ResponseEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/response_set_entity_listing.py b/build/PureCloudPlatformClientV2/models/response_set_entity_listing.py
index e0062c9f6..922e1f53f 100644
--- a/build/PureCloudPlatformClientV2/models/response_set_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/response_set_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ResponseSetEntityListing.
+ Gets the first_uri of this ResponseSetEntityListing.
- :return: The last_uri of this ResponseSetEntityListing.
+ :return: The first_uri of this ResponseSetEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ResponseSetEntityListing.
+ Sets the first_uri of this ResponseSetEntityListing.
- :param last_uri: The last_uri of this ResponseSetEntityListing.
+ :param first_uri: The first_uri of this ResponseSetEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ResponseSetEntityListing.
+ Gets the last_uri of this ResponseSetEntityListing.
- :return: The first_uri of this ResponseSetEntityListing.
+ :return: The last_uri of this ResponseSetEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ResponseSetEntityListing.
+ Sets the last_uri of this ResponseSetEntityListing.
- :param first_uri: The first_uri of this ResponseSetEntityListing.
+ :param last_uri: The last_uri of this ResponseSetEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/response_text.py b/build/PureCloudPlatformClientV2/models/response_text.py
index a48410062..cf8a3b138 100644
--- a/build/PureCloudPlatformClientV2/models/response_text.py
+++ b/build/PureCloudPlatformClientV2/models/response_text.py
@@ -49,16 +49,19 @@ def __init__(self) -> None:
"""
self.swagger_types = {
'content': 'str',
- 'content_type': 'str'
+ 'content_type': 'str',
+ 'type': 'str'
}
self.attribute_map = {
'content': 'content',
- 'content_type': 'contentType'
+ 'content_type': 'contentType',
+ 'type': 'type'
}
self._content = None
self._content_type = None
+ self._type = None
@property
def content(self) -> str:
@@ -113,6 +116,35 @@ def content_type(self, content_type: str) -> None:
else:
self._content_type = content_type
+ @property
+ def type(self) -> str:
+ """
+ Gets the type of this ResponseText.
+ Response text type.
+
+ :return: The type of this ResponseText.
+ :rtype: str
+ """
+ return self._type
+
+ @type.setter
+ def type(self, type: str) -> None:
+ """
+ Sets the type of this ResponseText.
+ Response text type.
+
+ :param type: The type of this ResponseText.
+ :type: str
+ """
+ if isinstance(type, int):
+ type = str(type)
+ allowed_values = ["body", "subject"]
+ if type.lower() not in map(str.lower, allowed_values):
+ # print("Invalid value for type -> " + type)
+ self._type = "outdated_sdk_version"
+ else:
+ self._type = type
+
def to_dict(self):
"""
Returns the model properties as a dict
diff --git a/build/PureCloudPlatformClientV2/models/routing_conversation_attributes_request.py b/build/PureCloudPlatformClientV2/models/routing_conversation_attributes_request.py
index 841570f91..397338c85 100644
--- a/build/PureCloudPlatformClientV2/models/routing_conversation_attributes_request.py
+++ b/build/PureCloudPlatformClientV2/models/routing_conversation_attributes_request.py
@@ -53,6 +53,7 @@ def __init__(self) -> None:
'priority': 'int',
'skill_ids': 'list[str]',
'language_id': 'str',
+ 'label_id': 'str',
'request_scored_agents': 'list[RequestScoredAgent]'
}
@@ -60,12 +61,14 @@ def __init__(self) -> None:
'priority': 'priority',
'skill_ids': 'skillIds',
'language_id': 'languageId',
+ 'label_id': 'labelId',
'request_scored_agents': 'requestScoredAgents'
}
self._priority = None
self._skill_ids = None
self._language_id = None
+ self._label_id = None
self._request_scored_agents = None
@property
@@ -146,6 +149,30 @@ def language_id(self, language_id: str) -> None:
self._language_id = language_id
+ @property
+ def label_id(self) -> str:
+ """
+ Gets the label_id of this RoutingConversationAttributesRequest.
+ Label requirement for the conversation. To remove the label requirement (setting it to System Default Label), specify an empty string, i.e., \"\".
+
+ :return: The label_id of this RoutingConversationAttributesRequest.
+ :rtype: str
+ """
+ return self._label_id
+
+ @label_id.setter
+ def label_id(self, label_id: str) -> None:
+ """
+ Sets the label_id of this RoutingConversationAttributesRequest.
+ Label requirement for the conversation. To remove the label requirement (setting it to System Default Label), specify an empty string, i.e., \"\".
+
+ :param label_id: The label_id of this RoutingConversationAttributesRequest.
+ :type: str
+ """
+
+
+ self._label_id = label_id
+
@property
def request_scored_agents(self) -> List['RequestScoredAgent']:
"""
diff --git a/build/PureCloudPlatformClientV2/models/routing_conversation_attributes_response.py b/build/PureCloudPlatformClientV2/models/routing_conversation_attributes_response.py
index 71d4ead01..850c3bef3 100644
--- a/build/PureCloudPlatformClientV2/models/routing_conversation_attributes_response.py
+++ b/build/PureCloudPlatformClientV2/models/routing_conversation_attributes_response.py
@@ -36,6 +36,7 @@
from . import Language
from . import RoutingSkill
from . import ScoredAgent
+ from . import UtilizationLabel
class RoutingConversationAttributesResponse(object):
"""
@@ -55,6 +56,7 @@ def __init__(self) -> None:
'priority': 'int',
'skills': 'list[RoutingSkill]',
'language': 'Language',
+ 'label': 'UtilizationLabel',
'scored_agents': 'list[ScoredAgent]'
}
@@ -62,12 +64,14 @@ def __init__(self) -> None:
'priority': 'priority',
'skills': 'skills',
'language': 'language',
+ 'label': 'label',
'scored_agents': 'scoredAgents'
}
self._priority = None
self._skills = None
self._language = None
+ self._label = None
self._scored_agents = None
@property
@@ -142,6 +146,30 @@ def language(self, language: 'Language') -> None:
self._language = language
+ @property
+ def label(self) -> 'UtilizationLabel':
+ """
+ Gets the label of this RoutingConversationAttributesResponse.
+ Current label on in-queue conversation
+
+ :return: The label of this RoutingConversationAttributesResponse.
+ :rtype: UtilizationLabel
+ """
+ return self._label
+
+ @label.setter
+ def label(self, label: 'UtilizationLabel') -> None:
+ """
+ Sets the label of this RoutingConversationAttributesResponse.
+ Current label on in-queue conversation
+
+ :param label: The label of this RoutingConversationAttributesResponse.
+ :type: UtilizationLabel
+ """
+
+
+ self._label = label
+
@property
def scored_agents(self) -> List['ScoredAgent']:
"""
diff --git a/build/PureCloudPlatformClientV2/models/rule_config.py b/build/PureCloudPlatformClientV2/models/rule_config.py
new file mode 100644
index 000000000..f645c396e
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/rule_config.py
@@ -0,0 +1,195 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import CopilotRule
+
+class RuleConfig(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ RuleConfig - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'id': 'str',
+ 'enabled': 'bool',
+ 'rule': 'CopilotRule'
+ }
+
+ self.attribute_map = {
+ 'id': 'id',
+ 'enabled': 'enabled',
+ 'rule': 'rule'
+ }
+
+ self._id = None
+ self._enabled = None
+ self._rule = None
+
+ @property
+ def id(self) -> str:
+ """
+ Gets the id of this RuleConfig.
+ Rule ID.
+
+ :return: The id of this RuleConfig.
+ :rtype: str
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id: str) -> None:
+ """
+ Sets the id of this RuleConfig.
+ Rule ID.
+
+ :param id: The id of this RuleConfig.
+ :type: str
+ """
+
+
+ self._id = id
+
+ @property
+ def enabled(self) -> bool:
+ """
+ Gets the enabled of this RuleConfig.
+ Rule enabled.
+
+ :return: The enabled of this RuleConfig.
+ :rtype: bool
+ """
+ return self._enabled
+
+ @enabled.setter
+ def enabled(self, enabled: bool) -> None:
+ """
+ Sets the enabled of this RuleConfig.
+ Rule enabled.
+
+ :param enabled: The enabled of this RuleConfig.
+ :type: bool
+ """
+
+
+ self._enabled = enabled
+
+ @property
+ def rule(self) -> 'CopilotRule':
+ """
+ Gets the rule of this RuleConfig.
+ Rule configuration.
+
+ :return: The rule of this RuleConfig.
+ :rtype: CopilotRule
+ """
+ return self._rule
+
+ @rule.setter
+ def rule(self, rule: 'CopilotRule') -> None:
+ """
+ Sets the rule of this RuleConfig.
+ Rule configuration.
+
+ :param rule: The rule of this RuleConfig.
+ :type: CopilotRule
+ """
+
+
+ self._rule = rule
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/rule_engine_config.py b/build/PureCloudPlatformClientV2/models/rule_engine_config.py
new file mode 100644
index 000000000..4b9b40b95
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/rule_engine_config.py
@@ -0,0 +1,169 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+if TYPE_CHECKING:
+ from . import Fallback
+ from . import RuleConfig
+
+class RuleEngineConfig(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ RuleEngineConfig - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'rules': 'list[RuleConfig]',
+ 'fallback': 'Fallback'
+ }
+
+ self.attribute_map = {
+ 'rules': 'rules',
+ 'fallback': 'fallback'
+ }
+
+ self._rules = None
+ self._fallback = None
+
+ @property
+ def rules(self) -> List['RuleConfig']:
+ """
+ Gets the rules of this RuleEngineConfig.
+ List of rules to evaluate by the engine.
+
+ :return: The rules of this RuleEngineConfig.
+ :rtype: list[RuleConfig]
+ """
+ return self._rules
+
+ @rules.setter
+ def rules(self, rules: List['RuleConfig']) -> None:
+ """
+ Sets the rules of this RuleEngineConfig.
+ List of rules to evaluate by the engine.
+
+ :param rules: The rules of this RuleEngineConfig.
+ :type: list[RuleConfig]
+ """
+
+
+ self._rules = rules
+
+ @property
+ def fallback(self) -> 'Fallback':
+ """
+ Gets the fallback of this RuleEngineConfig.
+ Fallback configuration.
+
+ :return: The fallback of this RuleEngineConfig.
+ :rtype: Fallback
+ """
+ return self._fallback
+
+ @fallback.setter
+ def fallback(self, fallback: 'Fallback') -> None:
+ """
+ Sets the fallback of this RuleEngineConfig.
+ Fallback configuration.
+
+ :param fallback: The fallback of this RuleEngineConfig.
+ :type: Fallback
+ """
+
+
+ self._fallback = fallback
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/rule_set_entity_listing.py b/build/PureCloudPlatformClientV2/models/rule_set_entity_listing.py
index c3b5c9298..945f074fa 100644
--- a/build/PureCloudPlatformClientV2/models/rule_set_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/rule_set_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this RuleSetEntityListing.
+ Gets the first_uri of this RuleSetEntityListing.
- :return: The last_uri of this RuleSetEntityListing.
+ :return: The first_uri of this RuleSetEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this RuleSetEntityListing.
+ Sets the first_uri of this RuleSetEntityListing.
- :param last_uri: The last_uri of this RuleSetEntityListing.
+ :param first_uri: The first_uri of this RuleSetEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this RuleSetEntityListing.
+ Gets the last_uri of this RuleSetEntityListing.
- :return: The first_uri of this RuleSetEntityListing.
+ :return: The last_uri of this RuleSetEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this RuleSetEntityListing.
+ Sets the last_uri of this RuleSetEntityListing.
- :param first_uri: The first_uri of this RuleSetEntityListing.
+ :param last_uri: The last_uri of this RuleSetEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/schedule_division_view_entity_listing.py b/build/PureCloudPlatformClientV2/models/schedule_division_view_entity_listing.py
index 9fc5c2e8d..dd2dc5bde 100644
--- a/build/PureCloudPlatformClientV2/models/schedule_division_view_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/schedule_division_view_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ScheduleDivisionViewEntityListing.
+ Gets the first_uri of this ScheduleDivisionViewEntityListing.
- :return: The last_uri of this ScheduleDivisionViewEntityListing.
+ :return: The first_uri of this ScheduleDivisionViewEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ScheduleDivisionViewEntityListing.
+ Sets the first_uri of this ScheduleDivisionViewEntityListing.
- :param last_uri: The last_uri of this ScheduleDivisionViewEntityListing.
+ :param first_uri: The first_uri of this ScheduleDivisionViewEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ScheduleDivisionViewEntityListing.
+ Gets the last_uri of this ScheduleDivisionViewEntityListing.
- :return: The first_uri of this ScheduleDivisionViewEntityListing.
+ :return: The last_uri of this ScheduleDivisionViewEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ScheduleDivisionViewEntityListing.
+ Sets the last_uri of this ScheduleDivisionViewEntityListing.
- :param first_uri: The first_uri of this ScheduleDivisionViewEntityListing.
+ :param last_uri: The last_uri of this ScheduleDivisionViewEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/schedule_entity_listing.py b/build/PureCloudPlatformClientV2/models/schedule_entity_listing.py
index 117826b3f..a1bc13d6e 100644
--- a/build/PureCloudPlatformClientV2/models/schedule_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/schedule_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ScheduleEntityListing.
+ Gets the first_uri of this ScheduleEntityListing.
- :return: The last_uri of this ScheduleEntityListing.
+ :return: The first_uri of this ScheduleEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ScheduleEntityListing.
+ Sets the first_uri of this ScheduleEntityListing.
- :param last_uri: The last_uri of this ScheduleEntityListing.
+ :param first_uri: The first_uri of this ScheduleEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ScheduleEntityListing.
+ Gets the last_uri of this ScheduleEntityListing.
- :return: The first_uri of this ScheduleEntityListing.
+ :return: The last_uri of this ScheduleEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ScheduleEntityListing.
+ Sets the last_uri of this ScheduleEntityListing.
- :param first_uri: The first_uri of this ScheduleEntityListing.
+ :param last_uri: The last_uri of this ScheduleEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/schedule_group_division_view_entity_listing.py b/build/PureCloudPlatformClientV2/models/schedule_group_division_view_entity_listing.py
index bd23cafdf..9e6925ae2 100644
--- a/build/PureCloudPlatformClientV2/models/schedule_group_division_view_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/schedule_group_division_view_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ScheduleGroupDivisionViewEntityListing.
+ Gets the first_uri of this ScheduleGroupDivisionViewEntityListing.
- :return: The last_uri of this ScheduleGroupDivisionViewEntityListing.
+ :return: The first_uri of this ScheduleGroupDivisionViewEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ScheduleGroupDivisionViewEntityListing.
+ Sets the first_uri of this ScheduleGroupDivisionViewEntityListing.
- :param last_uri: The last_uri of this ScheduleGroupDivisionViewEntityListing.
+ :param first_uri: The first_uri of this ScheduleGroupDivisionViewEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ScheduleGroupDivisionViewEntityListing.
+ Gets the last_uri of this ScheduleGroupDivisionViewEntityListing.
- :return: The first_uri of this ScheduleGroupDivisionViewEntityListing.
+ :return: The last_uri of this ScheduleGroupDivisionViewEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ScheduleGroupDivisionViewEntityListing.
+ Sets the last_uri of this ScheduleGroupDivisionViewEntityListing.
- :param first_uri: The first_uri of this ScheduleGroupDivisionViewEntityListing.
+ :param last_uri: The last_uri of this ScheduleGroupDivisionViewEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/schedule_group_entity_listing.py b/build/PureCloudPlatformClientV2/models/schedule_group_entity_listing.py
index 4fbe086fd..0682f79f6 100644
--- a/build/PureCloudPlatformClientV2/models/schedule_group_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/schedule_group_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ScheduleGroupEntityListing.
+ Gets the first_uri of this ScheduleGroupEntityListing.
- :return: The last_uri of this ScheduleGroupEntityListing.
+ :return: The first_uri of this ScheduleGroupEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ScheduleGroupEntityListing.
+ Sets the first_uri of this ScheduleGroupEntityListing.
- :param last_uri: The last_uri of this ScheduleGroupEntityListing.
+ :param first_uri: The first_uri of this ScheduleGroupEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ScheduleGroupEntityListing.
+ Gets the last_uri of this ScheduleGroupEntityListing.
- :return: The first_uri of this ScheduleGroupEntityListing.
+ :return: The last_uri of this ScheduleGroupEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ScheduleGroupEntityListing.
+ Sets the last_uri of this ScheduleGroupEntityListing.
- :param first_uri: The first_uri of this ScheduleGroupEntityListing.
+ :param last_uri: The last_uri of this ScheduleGroupEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/screen_recording_session_listing.py b/build/PureCloudPlatformClientV2/models/screen_recording_session_listing.py
index a64718740..ab5cfacdf 100644
--- a/build/PureCloudPlatformClientV2/models/screen_recording_session_listing.py
+++ b/build/PureCloudPlatformClientV2/models/screen_recording_session_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ScreenRecordingSessionListing.
+ Gets the first_uri of this ScreenRecordingSessionListing.
- :return: The last_uri of this ScreenRecordingSessionListing.
+ :return: The first_uri of this ScreenRecordingSessionListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ScreenRecordingSessionListing.
+ Sets the first_uri of this ScreenRecordingSessionListing.
- :param last_uri: The last_uri of this ScreenRecordingSessionListing.
+ :param first_uri: The first_uri of this ScreenRecordingSessionListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ScreenRecordingSessionListing.
+ Gets the last_uri of this ScreenRecordingSessionListing.
- :return: The first_uri of this ScreenRecordingSessionListing.
+ :return: The last_uri of this ScreenRecordingSessionListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ScreenRecordingSessionListing.
+ Sets the last_uri of this ScreenRecordingSessionListing.
- :param first_uri: The first_uri of this ScreenRecordingSessionListing.
+ :param last_uri: The last_uri of this ScreenRecordingSessionListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/script_entity_listing.py b/build/PureCloudPlatformClientV2/models/script_entity_listing.py
index 14c19b6fc..0b2669e50 100644
--- a/build/PureCloudPlatformClientV2/models/script_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/script_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ScriptEntityListing.
+ Gets the first_uri of this ScriptEntityListing.
- :return: The last_uri of this ScriptEntityListing.
+ :return: The first_uri of this ScriptEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ScriptEntityListing.
+ Sets the first_uri of this ScriptEntityListing.
- :param last_uri: The last_uri of this ScriptEntityListing.
+ :param first_uri: The first_uri of this ScriptEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ScriptEntityListing.
+ Gets the last_uri of this ScriptEntityListing.
- :return: The first_uri of this ScriptEntityListing.
+ :return: The last_uri of this ScriptEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ScriptEntityListing.
+ Sets the last_uri of this ScriptEntityListing.
- :param first_uri: The first_uri of this ScriptEntityListing.
+ :param last_uri: The last_uri of this ScriptEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/security_profile_entity_listing.py b/build/PureCloudPlatformClientV2/models/security_profile_entity_listing.py
index 5b9f0989c..7cce9f15c 100644
--- a/build/PureCloudPlatformClientV2/models/security_profile_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/security_profile_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this SecurityProfileEntityListing.
+ Gets the first_uri of this SecurityProfileEntityListing.
- :return: The last_uri of this SecurityProfileEntityListing.
+ :return: The first_uri of this SecurityProfileEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this SecurityProfileEntityListing.
+ Sets the first_uri of this SecurityProfileEntityListing.
- :param last_uri: The last_uri of this SecurityProfileEntityListing.
+ :param first_uri: The first_uri of this SecurityProfileEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this SecurityProfileEntityListing.
+ Gets the last_uri of this SecurityProfileEntityListing.
- :return: The first_uri of this SecurityProfileEntityListing.
+ :return: The last_uri of this SecurityProfileEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this SecurityProfileEntityListing.
+ Sets the last_uri of this SecurityProfileEntityListing.
- :param first_uri: The first_uri of this SecurityProfileEntityListing.
+ :param last_uri: The last_uri of this SecurityProfileEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/segment_listing.py b/build/PureCloudPlatformClientV2/models/segment_listing.py
index b07b2db1f..0a0a6e31a 100644
--- a/build/PureCloudPlatformClientV2/models/segment_listing.py
+++ b/build/PureCloudPlatformClientV2/models/segment_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this SegmentListing.
+ Gets the first_uri of this SegmentListing.
- :return: The last_uri of this SegmentListing.
+ :return: The first_uri of this SegmentListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this SegmentListing.
+ Sets the first_uri of this SegmentListing.
- :param last_uri: The last_uri of this SegmentListing.
+ :param first_uri: The first_uri of this SegmentListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this SegmentListing.
+ Gets the last_uri of this SegmentListing.
- :return: The first_uri of this SegmentListing.
+ :return: The last_uri of this SegmentListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this SegmentListing.
+ Sets the last_uri of this SegmentListing.
- :param first_uri: The first_uri of this SegmentListing.
+ :param last_uri: The last_uri of this SegmentListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/share_entity_listing.py b/build/PureCloudPlatformClientV2/models/share_entity_listing.py
index ea4409410..887aa4d97 100644
--- a/build/PureCloudPlatformClientV2/models/share_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/share_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this ShareEntityListing.
+ Gets the first_uri of this ShareEntityListing.
- :return: The last_uri of this ShareEntityListing.
+ :return: The first_uri of this ShareEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this ShareEntityListing.
+ Sets the first_uri of this ShareEntityListing.
- :param last_uri: The last_uri of this ShareEntityListing.
+ :param first_uri: The first_uri of this ShareEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this ShareEntityListing.
+ Gets the last_uri of this ShareEntityListing.
- :return: The first_uri of this ShareEntityListing.
+ :return: The last_uri of this ShareEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this ShareEntityListing.
+ Sets the last_uri of this ShareEntityListing.
- :param first_uri: The first_uri of this ShareEntityListing.
+ :param last_uri: The last_uri of this ShareEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/site_entity_listing.py b/build/PureCloudPlatformClientV2/models/site_entity_listing.py
index f9121a9db..b08dfa2c4 100644
--- a/build/PureCloudPlatformClientV2/models/site_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/site_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this SiteEntityListing.
+ Gets the first_uri of this SiteEntityListing.
- :return: The last_uri of this SiteEntityListing.
+ :return: The first_uri of this SiteEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this SiteEntityListing.
+ Sets the first_uri of this SiteEntityListing.
- :param last_uri: The last_uri of this SiteEntityListing.
+ :param first_uri: The first_uri of this SiteEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this SiteEntityListing.
+ Gets the last_uri of this SiteEntityListing.
- :return: The first_uri of this SiteEntityListing.
+ :return: The last_uri of this SiteEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this SiteEntityListing.
+ Sets the last_uri of this SiteEntityListing.
- :param first_uri: The first_uri of this SiteEntityListing.
+ :param last_uri: The last_uri of this SiteEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/skill_entity_listing.py b/build/PureCloudPlatformClientV2/models/skill_entity_listing.py
index 468eec96c..8b454babe 100644
--- a/build/PureCloudPlatformClientV2/models/skill_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/skill_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this SkillEntityListing.
+ Gets the first_uri of this SkillEntityListing.
- :return: The last_uri of this SkillEntityListing.
+ :return: The first_uri of this SkillEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this SkillEntityListing.
+ Sets the first_uri of this SkillEntityListing.
- :param last_uri: The last_uri of this SkillEntityListing.
+ :param first_uri: The first_uri of this SkillEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this SkillEntityListing.
+ Gets the last_uri of this SkillEntityListing.
- :return: The first_uri of this SkillEntityListing.
+ :return: The last_uri of this SkillEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this SkillEntityListing.
+ Sets the last_uri of this SkillEntityListing.
- :param first_uri: The first_uri of this SkillEntityListing.
+ :param last_uri: The last_uri of this SkillEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/sms_address_entity_listing.py b/build/PureCloudPlatformClientV2/models/sms_address_entity_listing.py
index b44e21a82..8892a608a 100644
--- a/build/PureCloudPlatformClientV2/models/sms_address_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/sms_address_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this SmsAddressEntityListing.
+ Gets the first_uri of this SmsAddressEntityListing.
- :return: The last_uri of this SmsAddressEntityListing.
+ :return: The first_uri of this SmsAddressEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this SmsAddressEntityListing.
+ Sets the first_uri of this SmsAddressEntityListing.
- :param last_uri: The last_uri of this SmsAddressEntityListing.
+ :param first_uri: The first_uri of this SmsAddressEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this SmsAddressEntityListing.
+ Gets the last_uri of this SmsAddressEntityListing.
- :return: The first_uri of this SmsAddressEntityListing.
+ :return: The last_uri of this SmsAddressEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this SmsAddressEntityListing.
+ Sets the last_uri of this SmsAddressEntityListing.
- :param first_uri: The first_uri of this SmsAddressEntityListing.
+ :param last_uri: The last_uri of this SmsAddressEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/sms_phone_number_entity_listing.py b/build/PureCloudPlatformClientV2/models/sms_phone_number_entity_listing.py
index 6e92dcf6f..cdfe782e9 100644
--- a/build/PureCloudPlatformClientV2/models/sms_phone_number_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/sms_phone_number_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this SmsPhoneNumberEntityListing.
+ Gets the first_uri of this SmsPhoneNumberEntityListing.
- :return: The last_uri of this SmsPhoneNumberEntityListing.
+ :return: The first_uri of this SmsPhoneNumberEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this SmsPhoneNumberEntityListing.
+ Sets the first_uri of this SmsPhoneNumberEntityListing.
- :param last_uri: The last_uri of this SmsPhoneNumberEntityListing.
+ :param first_uri: The first_uri of this SmsPhoneNumberEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this SmsPhoneNumberEntityListing.
+ Gets the last_uri of this SmsPhoneNumberEntityListing.
- :return: The first_uri of this SmsPhoneNumberEntityListing.
+ :return: The last_uri of this SmsPhoneNumberEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this SmsPhoneNumberEntityListing.
+ Sets the last_uri of this SmsPhoneNumberEntityListing.
- :param first_uri: The first_uri of this SmsPhoneNumberEntityListing.
+ :param last_uri: The last_uri of this SmsPhoneNumberEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/station_entity_listing.py b/build/PureCloudPlatformClientV2/models/station_entity_listing.py
index fb47f6d76..60e0dbaaf 100644
--- a/build/PureCloudPlatformClientV2/models/station_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/station_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this StationEntityListing.
+ Gets the first_uri of this StationEntityListing.
- :return: The last_uri of this StationEntityListing.
+ :return: The first_uri of this StationEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this StationEntityListing.
+ Sets the first_uri of this StationEntityListing.
- :param last_uri: The last_uri of this StationEntityListing.
+ :param first_uri: The first_uri of this StationEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this StationEntityListing.
+ Gets the last_uri of this StationEntityListing.
- :return: The first_uri of this StationEntityListing.
+ :return: The last_uri of this StationEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this StationEntityListing.
+ Sets the last_uri of this StationEntityListing.
- :param first_uri: The first_uri of this StationEntityListing.
+ :param last_uri: The last_uri of this StationEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/stt_engine_entity_listing.py b/build/PureCloudPlatformClientV2/models/stt_engine_entity_listing.py
index 90c8adb4b..dfe9eaa5f 100644
--- a/build/PureCloudPlatformClientV2/models/stt_engine_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/stt_engine_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this SttEngineEntityListing.
+ Gets the first_uri of this SttEngineEntityListing.
- :return: The last_uri of this SttEngineEntityListing.
+ :return: The first_uri of this SttEngineEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this SttEngineEntityListing.
+ Sets the first_uri of this SttEngineEntityListing.
- :param last_uri: The last_uri of this SttEngineEntityListing.
+ :param first_uri: The first_uri of this SttEngineEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this SttEngineEntityListing.
+ Gets the last_uri of this SttEngineEntityListing.
- :return: The first_uri of this SttEngineEntityListing.
+ :return: The last_uri of this SttEngineEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this SttEngineEntityListing.
+ Sets the last_uri of this SttEngineEntityListing.
- :param first_uri: The first_uri of this SttEngineEntityListing.
+ :param last_uri: The last_uri of this SttEngineEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/subject_division_grants_entity_listing.py b/build/PureCloudPlatformClientV2/models/subject_division_grants_entity_listing.py
index e7a413ab4..58e35039b 100644
--- a/build/PureCloudPlatformClientV2/models/subject_division_grants_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/subject_division_grants_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this SubjectDivisionGrantsEntityListing.
+ Gets the first_uri of this SubjectDivisionGrantsEntityListing.
- :return: The last_uri of this SubjectDivisionGrantsEntityListing.
+ :return: The first_uri of this SubjectDivisionGrantsEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this SubjectDivisionGrantsEntityListing.
+ Sets the first_uri of this SubjectDivisionGrantsEntityListing.
- :param last_uri: The last_uri of this SubjectDivisionGrantsEntityListing.
+ :param first_uri: The first_uri of this SubjectDivisionGrantsEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this SubjectDivisionGrantsEntityListing.
+ Gets the last_uri of this SubjectDivisionGrantsEntityListing.
- :return: The first_uri of this SubjectDivisionGrantsEntityListing.
+ :return: The last_uri of this SubjectDivisionGrantsEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this SubjectDivisionGrantsEntityListing.
+ Sets the last_uri of this SubjectDivisionGrantsEntityListing.
- :param first_uri: The first_uri of this SubjectDivisionGrantsEntityListing.
+ :param last_uri: The last_uri of this SubjectDivisionGrantsEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/summary_generation_config.py b/build/PureCloudPlatformClientV2/models/summary_generation_config.py
new file mode 100644
index 000000000..2b056b77e
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/summary_generation_config.py
@@ -0,0 +1,139 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+
+class SummaryGenerationConfig(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ SummaryGenerationConfig - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'enabled': 'bool'
+ }
+
+ self.attribute_map = {
+ 'enabled': 'enabled'
+ }
+
+ self._enabled = None
+
+ @property
+ def enabled(self) -> bool:
+ """
+ Gets the enabled of this SummaryGenerationConfig.
+ Copilot generated summary is enabled.
+
+ :return: The enabled of this SummaryGenerationConfig.
+ :rtype: bool
+ """
+ return self._enabled
+
+ @enabled.setter
+ def enabled(self, enabled: bool) -> None:
+ """
+ Sets the enabled of this SummaryGenerationConfig.
+ Copilot generated summary is enabled.
+
+ :param enabled: The enabled of this SummaryGenerationConfig.
+ :type: bool
+ """
+
+
+ self._enabled = enabled
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/supported_content_listing.py b/build/PureCloudPlatformClientV2/models/supported_content_listing.py
index bdd424ba7..2b374d470 100644
--- a/build/PureCloudPlatformClientV2/models/supported_content_listing.py
+++ b/build/PureCloudPlatformClientV2/models/supported_content_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this SupportedContentListing.
+ Gets the first_uri of this SupportedContentListing.
- :return: The last_uri of this SupportedContentListing.
+ :return: The first_uri of this SupportedContentListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this SupportedContentListing.
+ Sets the first_uri of this SupportedContentListing.
- :param last_uri: The last_uri of this SupportedContentListing.
+ :param first_uri: The first_uri of this SupportedContentListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this SupportedContentListing.
+ Gets the last_uri of this SupportedContentListing.
- :return: The first_uri of this SupportedContentListing.
+ :return: The last_uri of this SupportedContentListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this SupportedContentListing.
+ Sets the last_uri of this SupportedContentListing.
- :param first_uri: The first_uri of this SupportedContentListing.
+ :param last_uri: The last_uri of this SupportedContentListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/survey_form_entity_listing.py b/build/PureCloudPlatformClientV2/models/survey_form_entity_listing.py
index fbfec288f..066c03655 100644
--- a/build/PureCloudPlatformClientV2/models/survey_form_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/survey_form_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this SurveyFormEntityListing.
+ Gets the first_uri of this SurveyFormEntityListing.
- :return: The last_uri of this SurveyFormEntityListing.
+ :return: The first_uri of this SurveyFormEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this SurveyFormEntityListing.
+ Sets the first_uri of this SurveyFormEntityListing.
- :param last_uri: The last_uri of this SurveyFormEntityListing.
+ :param first_uri: The first_uri of this SurveyFormEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this SurveyFormEntityListing.
+ Gets the last_uri of this SurveyFormEntityListing.
- :return: The first_uri of this SurveyFormEntityListing.
+ :return: The last_uri of this SurveyFormEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this SurveyFormEntityListing.
+ Sets the last_uri of this SurveyFormEntityListing.
- :param first_uri: The first_uri of this SurveyFormEntityListing.
+ :param last_uri: The last_uri of this SurveyFormEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/system_prompt_asset_entity_listing.py b/build/PureCloudPlatformClientV2/models/system_prompt_asset_entity_listing.py
index a5e5a9b6c..5a4785367 100644
--- a/build/PureCloudPlatformClientV2/models/system_prompt_asset_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/system_prompt_asset_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this SystemPromptAssetEntityListing.
+ Gets the first_uri of this SystemPromptAssetEntityListing.
- :return: The last_uri of this SystemPromptAssetEntityListing.
+ :return: The first_uri of this SystemPromptAssetEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this SystemPromptAssetEntityListing.
+ Sets the first_uri of this SystemPromptAssetEntityListing.
- :param last_uri: The last_uri of this SystemPromptAssetEntityListing.
+ :param first_uri: The first_uri of this SystemPromptAssetEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this SystemPromptAssetEntityListing.
+ Gets the last_uri of this SystemPromptAssetEntityListing.
- :return: The first_uri of this SystemPromptAssetEntityListing.
+ :return: The last_uri of this SystemPromptAssetEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this SystemPromptAssetEntityListing.
+ Sets the last_uri of this SystemPromptAssetEntityListing.
- :param first_uri: The first_uri of this SystemPromptAssetEntityListing.
+ :param last_uri: The last_uri of this SystemPromptAssetEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/system_prompt_entity_listing.py b/build/PureCloudPlatformClientV2/models/system_prompt_entity_listing.py
index b4e483146..fbb46a32e 100644
--- a/build/PureCloudPlatformClientV2/models/system_prompt_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/system_prompt_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this SystemPromptEntityListing.
+ Gets the first_uri of this SystemPromptEntityListing.
- :return: The last_uri of this SystemPromptEntityListing.
+ :return: The first_uri of this SystemPromptEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this SystemPromptEntityListing.
+ Sets the first_uri of this SystemPromptEntityListing.
- :param last_uri: The last_uri of this SystemPromptEntityListing.
+ :param first_uri: The first_uri of this SystemPromptEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this SystemPromptEntityListing.
+ Gets the last_uri of this SystemPromptEntityListing.
- :return: The first_uri of this SystemPromptEntityListing.
+ :return: The last_uri of this SystemPromptEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this SystemPromptEntityListing.
+ Sets the last_uri of this SystemPromptEntityListing.
- :param first_uri: The first_uri of this SystemPromptEntityListing.
+ :param last_uri: The last_uri of this SystemPromptEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/tag_value_entity_listing.py b/build/PureCloudPlatformClientV2/models/tag_value_entity_listing.py
index 07bdb8dad..adab8308f 100644
--- a/build/PureCloudPlatformClientV2/models/tag_value_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/tag_value_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this TagValueEntityListing.
+ Gets the first_uri of this TagValueEntityListing.
- :return: The last_uri of this TagValueEntityListing.
+ :return: The first_uri of this TagValueEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this TagValueEntityListing.
+ Sets the first_uri of this TagValueEntityListing.
- :param last_uri: The last_uri of this TagValueEntityListing.
+ :param first_uri: The first_uri of this TagValueEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this TagValueEntityListing.
+ Gets the last_uri of this TagValueEntityListing.
- :return: The first_uri of this TagValueEntityListing.
+ :return: The last_uri of this TagValueEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this TagValueEntityListing.
+ Sets the last_uri of this TagValueEntityListing.
- :param first_uri: The first_uri of this TagValueEntityListing.
+ :param last_uri: The last_uri of this TagValueEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/time_zone_entity_listing.py b/build/PureCloudPlatformClientV2/models/time_zone_entity_listing.py
index ba58e1e51..28a421973 100644
--- a/build/PureCloudPlatformClientV2/models/time_zone_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/time_zone_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this TimeZoneEntityListing.
+ Gets the first_uri of this TimeZoneEntityListing.
- :return: The last_uri of this TimeZoneEntityListing.
+ :return: The first_uri of this TimeZoneEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this TimeZoneEntityListing.
+ Sets the first_uri of this TimeZoneEntityListing.
- :param last_uri: The last_uri of this TimeZoneEntityListing.
+ :param first_uri: The first_uri of this TimeZoneEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this TimeZoneEntityListing.
+ Gets the last_uri of this TimeZoneEntityListing.
- :return: The first_uri of this TimeZoneEntityListing.
+ :return: The last_uri of this TimeZoneEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this TimeZoneEntityListing.
+ Sets the last_uri of this TimeZoneEntityListing.
- :param first_uri: The first_uri of this TimeZoneEntityListing.
+ :param last_uri: The last_uri of this TimeZoneEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/transcription_config.py b/build/PureCloudPlatformClientV2/models/transcription_config.py
new file mode 100644
index 000000000..1b4b1655a
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/transcription_config.py
@@ -0,0 +1,144 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+
+class TranscriptionConfig(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ TranscriptionConfig - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'vendor_name': 'str'
+ }
+
+ self.attribute_map = {
+ 'vendor_name': 'vendorName'
+ }
+
+ self._vendor_name = None
+
+ @property
+ def vendor_name(self) -> str:
+ """
+ Gets the vendor_name of this TranscriptionConfig.
+ The name of the vendor used for speech transcription.
+
+ :return: The vendor_name of this TranscriptionConfig.
+ :rtype: str
+ """
+ return self._vendor_name
+
+ @vendor_name.setter
+ def vendor_name(self, vendor_name: str) -> None:
+ """
+ Sets the vendor_name of this TranscriptionConfig.
+ The name of the vendor used for speech transcription.
+
+ :param vendor_name: The vendor_name of this TranscriptionConfig.
+ :type: str
+ """
+ if isinstance(vendor_name, int):
+ vendor_name = str(vendor_name)
+ allowed_values = ["GoogleDialogflow", "Unknown", "Genesys"]
+ if vendor_name.lower() not in map(str.lower, allowed_values):
+ # print("Invalid value for vendor_name -> " + vendor_name)
+ self._vendor_name = "outdated_sdk_version"
+ else:
+ self._vendor_name = vendor_name
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/transfer_request.py b/build/PureCloudPlatformClientV2/models/transfer_request.py
index 3de404043..a5b69dc96 100644
--- a/build/PureCloudPlatformClientV2/models/transfer_request.py
+++ b/build/PureCloudPlatformClientV2/models/transfer_request.py
@@ -49,6 +49,7 @@ def __init__(self) -> None:
"""
self.swagger_types = {
'transfer_type': 'str',
+ 'keep_internal_message_alive': 'bool',
'user_id': 'str',
'address': 'str',
'user_name': 'str',
@@ -58,6 +59,7 @@ def __init__(self) -> None:
self.attribute_map = {
'transfer_type': 'transferType',
+ 'keep_internal_message_alive': 'keepInternalMessageAlive',
'user_id': 'userId',
'address': 'address',
'user_name': 'userName',
@@ -66,6 +68,7 @@ def __init__(self) -> None:
}
self._transfer_type = None
+ self._keep_internal_message_alive = None
self._user_id = None
self._address = None
self._user_name = None
@@ -101,6 +104,30 @@ def transfer_type(self, transfer_type: str) -> None:
else:
self._transfer_type = transfer_type
+ @property
+ def keep_internal_message_alive(self) -> bool:
+ """
+ Gets the keep_internal_message_alive of this TransferRequest.
+ If true, the digital internal message will NOT be terminated.
+
+ :return: The keep_internal_message_alive of this TransferRequest.
+ :rtype: bool
+ """
+ return self._keep_internal_message_alive
+
+ @keep_internal_message_alive.setter
+ def keep_internal_message_alive(self, keep_internal_message_alive: bool) -> None:
+ """
+ Sets the keep_internal_message_alive of this TransferRequest.
+ If true, the digital internal message will NOT be terminated.
+
+ :param keep_internal_message_alive: The keep_internal_message_alive of this TransferRequest.
+ :type: bool
+ """
+
+
+ self._keep_internal_message_alive = keep_internal_message_alive
+
@property
def user_id(self) -> str:
"""
diff --git a/build/PureCloudPlatformClientV2/models/transfer_to_agent_request.py b/build/PureCloudPlatformClientV2/models/transfer_to_agent_request.py
index 59919ef2f..dc6491a55 100644
--- a/build/PureCloudPlatformClientV2/models/transfer_to_agent_request.py
+++ b/build/PureCloudPlatformClientV2/models/transfer_to_agent_request.py
@@ -49,6 +49,7 @@ def __init__(self) -> None:
"""
self.swagger_types = {
'transfer_type': 'str',
+ 'keep_internal_message_alive': 'bool',
'user_id': 'str',
'user_name': 'str',
'user_display_name': 'str',
@@ -57,6 +58,7 @@ def __init__(self) -> None:
self.attribute_map = {
'transfer_type': 'transferType',
+ 'keep_internal_message_alive': 'keepInternalMessageAlive',
'user_id': 'userId',
'user_name': 'userName',
'user_display_name': 'userDisplayName',
@@ -64,6 +66,7 @@ def __init__(self) -> None:
}
self._transfer_type = None
+ self._keep_internal_message_alive = None
self._user_id = None
self._user_name = None
self._user_display_name = None
@@ -98,6 +101,30 @@ def transfer_type(self, transfer_type: str) -> None:
else:
self._transfer_type = transfer_type
+ @property
+ def keep_internal_message_alive(self) -> bool:
+ """
+ Gets the keep_internal_message_alive of this TransferToAgentRequest.
+ If true, the digital internal message will NOT be terminated.
+
+ :return: The keep_internal_message_alive of this TransferToAgentRequest.
+ :rtype: bool
+ """
+ return self._keep_internal_message_alive
+
+ @keep_internal_message_alive.setter
+ def keep_internal_message_alive(self, keep_internal_message_alive: bool) -> None:
+ """
+ Sets the keep_internal_message_alive of this TransferToAgentRequest.
+ If true, the digital internal message will NOT be terminated.
+
+ :param keep_internal_message_alive: The keep_internal_message_alive of this TransferToAgentRequest.
+ :type: bool
+ """
+
+
+ self._keep_internal_message_alive = keep_internal_message_alive
+
@property
def user_id(self) -> str:
"""
diff --git a/build/PureCloudPlatformClientV2/models/transfer_to_external_request.py b/build/PureCloudPlatformClientV2/models/transfer_to_external_request.py
index 561b7999a..312f52d59 100644
--- a/build/PureCloudPlatformClientV2/models/transfer_to_external_request.py
+++ b/build/PureCloudPlatformClientV2/models/transfer_to_external_request.py
@@ -49,15 +49,18 @@ def __init__(self) -> None:
"""
self.swagger_types = {
'transfer_type': 'str',
+ 'keep_internal_message_alive': 'bool',
'address': 'str'
}
self.attribute_map = {
'transfer_type': 'transferType',
+ 'keep_internal_message_alive': 'keepInternalMessageAlive',
'address': 'address'
}
self._transfer_type = None
+ self._keep_internal_message_alive = None
self._address = None
@property
@@ -89,6 +92,30 @@ def transfer_type(self, transfer_type: str) -> None:
else:
self._transfer_type = transfer_type
+ @property
+ def keep_internal_message_alive(self) -> bool:
+ """
+ Gets the keep_internal_message_alive of this TransferToExternalRequest.
+ If true, the digital internal message will NOT be terminated.
+
+ :return: The keep_internal_message_alive of this TransferToExternalRequest.
+ :rtype: bool
+ """
+ return self._keep_internal_message_alive
+
+ @keep_internal_message_alive.setter
+ def keep_internal_message_alive(self, keep_internal_message_alive: bool) -> None:
+ """
+ Sets the keep_internal_message_alive of this TransferToExternalRequest.
+ If true, the digital internal message will NOT be terminated.
+
+ :param keep_internal_message_alive: The keep_internal_message_alive of this TransferToExternalRequest.
+ :type: bool
+ """
+
+
+ self._keep_internal_message_alive = keep_internal_message_alive
+
@property
def address(self) -> str:
"""
diff --git a/build/PureCloudPlatformClientV2/models/transfer_to_queue_request.py b/build/PureCloudPlatformClientV2/models/transfer_to_queue_request.py
index 732404414..7626988ad 100644
--- a/build/PureCloudPlatformClientV2/models/transfer_to_queue_request.py
+++ b/build/PureCloudPlatformClientV2/models/transfer_to_queue_request.py
@@ -49,17 +49,20 @@ def __init__(self) -> None:
"""
self.swagger_types = {
'transfer_type': 'str',
+ 'keep_internal_message_alive': 'bool',
'queue_id': 'str',
'queue_name': 'str'
}
self.attribute_map = {
'transfer_type': 'transferType',
+ 'keep_internal_message_alive': 'keepInternalMessageAlive',
'queue_id': 'queueId',
'queue_name': 'queueName'
}
self._transfer_type = None
+ self._keep_internal_message_alive = None
self._queue_id = None
self._queue_name = None
@@ -92,6 +95,30 @@ def transfer_type(self, transfer_type: str) -> None:
else:
self._transfer_type = transfer_type
+ @property
+ def keep_internal_message_alive(self) -> bool:
+ """
+ Gets the keep_internal_message_alive of this TransferToQueueRequest.
+ If true, the digital internal message will NOT be terminated.
+
+ :return: The keep_internal_message_alive of this TransferToQueueRequest.
+ :rtype: bool
+ """
+ return self._keep_internal_message_alive
+
+ @keep_internal_message_alive.setter
+ def keep_internal_message_alive(self, keep_internal_message_alive: bool) -> None:
+ """
+ Sets the keep_internal_message_alive of this TransferToQueueRequest.
+ If true, the digital internal message will NOT be terminated.
+
+ :param keep_internal_message_alive: The keep_internal_message_alive of this TransferToQueueRequest.
+ :type: bool
+ """
+
+
+ self._keep_internal_message_alive = keep_internal_message_alive
+
@property
def queue_id(self) -> str:
"""
diff --git a/build/PureCloudPlatformClientV2/models/trunk_base_entity_listing.py b/build/PureCloudPlatformClientV2/models/trunk_base_entity_listing.py
index 1aeed159d..d7edc1fd9 100644
--- a/build/PureCloudPlatformClientV2/models/trunk_base_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/trunk_base_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this TrunkBaseEntityListing.
+ Gets the first_uri of this TrunkBaseEntityListing.
- :return: The last_uri of this TrunkBaseEntityListing.
+ :return: The first_uri of this TrunkBaseEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this TrunkBaseEntityListing.
+ Sets the first_uri of this TrunkBaseEntityListing.
- :param last_uri: The last_uri of this TrunkBaseEntityListing.
+ :param first_uri: The first_uri of this TrunkBaseEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this TrunkBaseEntityListing.
+ Gets the last_uri of this TrunkBaseEntityListing.
- :return: The first_uri of this TrunkBaseEntityListing.
+ :return: The last_uri of this TrunkBaseEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this TrunkBaseEntityListing.
+ Sets the last_uri of this TrunkBaseEntityListing.
- :param first_uri: The first_uri of this TrunkBaseEntityListing.
+ :param last_uri: The last_uri of this TrunkBaseEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/trunk_entity_listing.py b/build/PureCloudPlatformClientV2/models/trunk_entity_listing.py
index a77087b6f..34d8c31f5 100644
--- a/build/PureCloudPlatformClientV2/models/trunk_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/trunk_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this TrunkEntityListing.
+ Gets the first_uri of this TrunkEntityListing.
- :return: The last_uri of this TrunkEntityListing.
+ :return: The first_uri of this TrunkEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this TrunkEntityListing.
+ Sets the first_uri of this TrunkEntityListing.
- :param last_uri: The last_uri of this TrunkEntityListing.
+ :param first_uri: The first_uri of this TrunkEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this TrunkEntityListing.
+ Gets the last_uri of this TrunkEntityListing.
- :return: The first_uri of this TrunkEntityListing.
+ :return: The last_uri of this TrunkEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this TrunkEntityListing.
+ Sets the last_uri of this TrunkEntityListing.
- :param first_uri: The first_uri of this TrunkEntityListing.
+ :param last_uri: The last_uri of this TrunkEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/trunk_metabase_entity_listing.py b/build/PureCloudPlatformClientV2/models/trunk_metabase_entity_listing.py
index 0ded8348c..a3a0eeaf9 100644
--- a/build/PureCloudPlatformClientV2/models/trunk_metabase_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/trunk_metabase_entity_listing.py
@@ -55,8 +55,8 @@ def __init__(self) -> None:
'page_number': 'int',
'total': 'int',
'total_number_of_entities': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -69,8 +69,8 @@ def __init__(self) -> None:
'page_number': 'pageNumber',
'total': 'total',
'total_number_of_entities': 'totalNumberOfEntities',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -82,8 +82,8 @@ def __init__(self) -> None:
self._page_number = None
self._total = None
self._total_number_of_entities = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -210,52 +210,52 @@ def total_number_of_entities(self, total_number_of_entities: int) -> None:
self._total_number_of_entities = total_number_of_entities
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this TrunkMetabaseEntityListing.
+ Gets the first_uri of this TrunkMetabaseEntityListing.
- :return: The last_uri of this TrunkMetabaseEntityListing.
+ :return: The first_uri of this TrunkMetabaseEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this TrunkMetabaseEntityListing.
+ Sets the first_uri of this TrunkMetabaseEntityListing.
- :param last_uri: The last_uri of this TrunkMetabaseEntityListing.
+ :param first_uri: The first_uri of this TrunkMetabaseEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this TrunkMetabaseEntityListing.
+ Gets the last_uri of this TrunkMetabaseEntityListing.
- :return: The first_uri of this TrunkMetabaseEntityListing.
+ :return: The last_uri of this TrunkMetabaseEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this TrunkMetabaseEntityListing.
+ Sets the last_uri of this TrunkMetabaseEntityListing.
- :param first_uri: The first_uri of this TrunkMetabaseEntityListing.
+ :param last_uri: The last_uri of this TrunkMetabaseEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/trust_entity_listing.py b/build/PureCloudPlatformClientV2/models/trust_entity_listing.py
index 1628fb2f7..2e7d9d9e6 100644
--- a/build/PureCloudPlatformClientV2/models/trust_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/trust_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this TrustEntityListing.
+ Gets the first_uri of this TrustEntityListing.
- :return: The last_uri of this TrustEntityListing.
+ :return: The first_uri of this TrustEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this TrustEntityListing.
+ Sets the first_uri of this TrustEntityListing.
- :param last_uri: The last_uri of this TrustEntityListing.
+ :param first_uri: The first_uri of this TrustEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this TrustEntityListing.
+ Gets the last_uri of this TrustEntityListing.
- :return: The first_uri of this TrustEntityListing.
+ :return: The last_uri of this TrustEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this TrustEntityListing.
+ Sets the last_uri of this TrustEntityListing.
- :param first_uri: The first_uri of this TrustEntityListing.
+ :param last_uri: The last_uri of this TrustEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/trust_group_entity_listing.py b/build/PureCloudPlatformClientV2/models/trust_group_entity_listing.py
index fb00cc6cf..fea577805 100644
--- a/build/PureCloudPlatformClientV2/models/trust_group_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/trust_group_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this TrustGroupEntityListing.
+ Gets the first_uri of this TrustGroupEntityListing.
- :return: The last_uri of this TrustGroupEntityListing.
+ :return: The first_uri of this TrustGroupEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this TrustGroupEntityListing.
+ Sets the first_uri of this TrustGroupEntityListing.
- :param last_uri: The last_uri of this TrustGroupEntityListing.
+ :param first_uri: The first_uri of this TrustGroupEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this TrustGroupEntityListing.
+ Gets the last_uri of this TrustGroupEntityListing.
- :return: The first_uri of this TrustGroupEntityListing.
+ :return: The last_uri of this TrustGroupEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this TrustGroupEntityListing.
+ Sets the last_uri of this TrustGroupEntityListing.
- :param first_uri: The first_uri of this TrustGroupEntityListing.
+ :param last_uri: The last_uri of this TrustGroupEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/trust_user_entity_listing.py b/build/PureCloudPlatformClientV2/models/trust_user_entity_listing.py
index efcd4d526..34b6dab35 100644
--- a/build/PureCloudPlatformClientV2/models/trust_user_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/trust_user_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this TrustUserEntityListing.
+ Gets the first_uri of this TrustUserEntityListing.
- :return: The last_uri of this TrustUserEntityListing.
+ :return: The first_uri of this TrustUserEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this TrustUserEntityListing.
+ Sets the first_uri of this TrustUserEntityListing.
- :param last_uri: The last_uri of this TrustUserEntityListing.
+ :param first_uri: The first_uri of this TrustUserEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this TrustUserEntityListing.
+ Gets the last_uri of this TrustUserEntityListing.
- :return: The first_uri of this TrustUserEntityListing.
+ :return: The last_uri of this TrustUserEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this TrustUserEntityListing.
+ Sets the last_uri of this TrustUserEntityListing.
- :param first_uri: The first_uri of this TrustUserEntityListing.
+ :param last_uri: The last_uri of this TrustUserEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/trustor_entity_listing.py b/build/PureCloudPlatformClientV2/models/trustor_entity_listing.py
index 55d258eb8..28ec95ab1 100644
--- a/build/PureCloudPlatformClientV2/models/trustor_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/trustor_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this TrustorEntityListing.
+ Gets the first_uri of this TrustorEntityListing.
- :return: The last_uri of this TrustorEntityListing.
+ :return: The first_uri of this TrustorEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this TrustorEntityListing.
+ Sets the first_uri of this TrustorEntityListing.
- :param last_uri: The last_uri of this TrustorEntityListing.
+ :param first_uri: The first_uri of this TrustorEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this TrustorEntityListing.
+ Gets the last_uri of this TrustorEntityListing.
- :return: The first_uri of this TrustorEntityListing.
+ :return: The last_uri of this TrustorEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this TrustorEntityListing.
+ Sets the last_uri of this TrustorEntityListing.
- :param first_uri: The first_uri of this TrustorEntityListing.
+ :param last_uri: The last_uri of this TrustorEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/tts_engine_entity_listing.py b/build/PureCloudPlatformClientV2/models/tts_engine_entity_listing.py
index 01cfc29cf..a9455c6e4 100644
--- a/build/PureCloudPlatformClientV2/models/tts_engine_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/tts_engine_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this TtsEngineEntityListing.
+ Gets the first_uri of this TtsEngineEntityListing.
- :return: The last_uri of this TtsEngineEntityListing.
+ :return: The first_uri of this TtsEngineEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this TtsEngineEntityListing.
+ Sets the first_uri of this TtsEngineEntityListing.
- :param last_uri: The last_uri of this TtsEngineEntityListing.
+ :param first_uri: The first_uri of this TtsEngineEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this TtsEngineEntityListing.
+ Gets the last_uri of this TtsEngineEntityListing.
- :return: The first_uri of this TtsEngineEntityListing.
+ :return: The last_uri of this TtsEngineEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this TtsEngineEntityListing.
+ Sets the last_uri of this TtsEngineEntityListing.
- :param first_uri: The first_uri of this TtsEngineEntityListing.
+ :param last_uri: The last_uri of this TtsEngineEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/tts_voice_entity_listing.py b/build/PureCloudPlatformClientV2/models/tts_voice_entity_listing.py
index c35277adc..f95a65fe1 100644
--- a/build/PureCloudPlatformClientV2/models/tts_voice_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/tts_voice_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this TtsVoiceEntityListing.
+ Gets the first_uri of this TtsVoiceEntityListing.
- :return: The last_uri of this TtsVoiceEntityListing.
+ :return: The first_uri of this TtsVoiceEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this TtsVoiceEntityListing.
+ Sets the first_uri of this TtsVoiceEntityListing.
- :param last_uri: The last_uri of this TtsVoiceEntityListing.
+ :param first_uri: The first_uri of this TtsVoiceEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this TtsVoiceEntityListing.
+ Gets the last_uri of this TtsVoiceEntityListing.
- :return: The first_uri of this TtsVoiceEntityListing.
+ :return: The last_uri of this TtsVoiceEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this TtsVoiceEntityListing.
+ Sets the last_uri of this TtsVoiceEntityListing.
- :param first_uri: The first_uri of this TtsVoiceEntityListing.
+ :param last_uri: The last_uri of this TtsVoiceEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/uc_integration_listing.py b/build/PureCloudPlatformClientV2/models/uc_integration_listing.py
index 108cff062..acee0ae1b 100644
--- a/build/PureCloudPlatformClientV2/models/uc_integration_listing.py
+++ b/build/PureCloudPlatformClientV2/models/uc_integration_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this UCIntegrationListing.
+ Gets the first_uri of this UCIntegrationListing.
- :return: The last_uri of this UCIntegrationListing.
+ :return: The first_uri of this UCIntegrationListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this UCIntegrationListing.
+ Sets the first_uri of this UCIntegrationListing.
- :param last_uri: The last_uri of this UCIntegrationListing.
+ :param first_uri: The first_uri of this UCIntegrationListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this UCIntegrationListing.
+ Gets the last_uri of this UCIntegrationListing.
- :return: The first_uri of this UCIntegrationListing.
+ :return: The last_uri of this UCIntegrationListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this UCIntegrationListing.
+ Sets the last_uri of this UCIntegrationListing.
- :param first_uri: The first_uri of this UCIntegrationListing.
+ :param last_uri: The last_uri of this UCIntegrationListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/unified_communications_integration_listing.py b/build/PureCloudPlatformClientV2/models/unified_communications_integration_listing.py
index 79f8172a9..e9667e9b0 100644
--- a/build/PureCloudPlatformClientV2/models/unified_communications_integration_listing.py
+++ b/build/PureCloudPlatformClientV2/models/unified_communications_integration_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this UnifiedCommunicationsIntegrationListing.
+ Gets the first_uri of this UnifiedCommunicationsIntegrationListing.
- :return: The last_uri of this UnifiedCommunicationsIntegrationListing.
+ :return: The first_uri of this UnifiedCommunicationsIntegrationListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this UnifiedCommunicationsIntegrationListing.
+ Sets the first_uri of this UnifiedCommunicationsIntegrationListing.
- :param last_uri: The last_uri of this UnifiedCommunicationsIntegrationListing.
+ :param first_uri: The first_uri of this UnifiedCommunicationsIntegrationListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this UnifiedCommunicationsIntegrationListing.
+ Gets the last_uri of this UnifiedCommunicationsIntegrationListing.
- :return: The first_uri of this UnifiedCommunicationsIntegrationListing.
+ :return: The last_uri of this UnifiedCommunicationsIntegrationListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this UnifiedCommunicationsIntegrationListing.
+ Sets the last_uri of this UnifiedCommunicationsIntegrationListing.
- :param first_uri: The first_uri of this UnifiedCommunicationsIntegrationListing.
+ :param last_uri: The last_uri of this UnifiedCommunicationsIntegrationListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/user_app_entity_listing.py b/build/PureCloudPlatformClientV2/models/user_app_entity_listing.py
index 9d47b397a..9ccba0c7b 100644
--- a/build/PureCloudPlatformClientV2/models/user_app_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/user_app_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this UserAppEntityListing.
+ Gets the first_uri of this UserAppEntityListing.
- :return: The last_uri of this UserAppEntityListing.
+ :return: The first_uri of this UserAppEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this UserAppEntityListing.
+ Sets the first_uri of this UserAppEntityListing.
- :param last_uri: The last_uri of this UserAppEntityListing.
+ :param first_uri: The first_uri of this UserAppEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this UserAppEntityListing.
+ Gets the last_uri of this UserAppEntityListing.
- :return: The first_uri of this UserAppEntityListing.
+ :return: The last_uri of this UserAppEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this UserAppEntityListing.
+ Sets the last_uri of this UserAppEntityListing.
- :param first_uri: The first_uri of this UserAppEntityListing.
+ :param last_uri: The last_uri of this UserAppEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/user_end_detail_event_topic_user_end_event.py b/build/PureCloudPlatformClientV2/models/user_end_detail_event_topic_user_end_event.py
index 36602162c..ea4867e9e 100644
--- a/build/PureCloudPlatformClientV2/models/user_end_detail_event_topic_user_end_event.py
+++ b/build/PureCloudPlatformClientV2/models/user_end_detail_event_topic_user_end_event.py
@@ -559,7 +559,7 @@ def message_type(self, message_type: str) -> None:
"""
if isinstance(message_type, int):
message_type = str(message_type)
- allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM"]
+ allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM", "APPLE"]
if message_type.lower() not in map(str.lower, allowed_values):
# print("Invalid value for message_type -> " + message_type)
self._message_type = "outdated_sdk_version"
diff --git a/build/PureCloudPlatformClientV2/models/user_entity_listing.py b/build/PureCloudPlatformClientV2/models/user_entity_listing.py
index f86cc33c4..887654825 100644
--- a/build/PureCloudPlatformClientV2/models/user_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/user_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this UserEntityListing.
+ Gets the first_uri of this UserEntityListing.
- :return: The last_uri of this UserEntityListing.
+ :return: The first_uri of this UserEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this UserEntityListing.
+ Sets the first_uri of this UserEntityListing.
- :param last_uri: The last_uri of this UserEntityListing.
+ :param first_uri: The first_uri of this UserEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this UserEntityListing.
+ Gets the last_uri of this UserEntityListing.
- :return: The first_uri of this UserEntityListing.
+ :return: The last_uri of this UserEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this UserEntityListing.
+ Sets the last_uri of this UserEntityListing.
- :param first_uri: The first_uri of this UserEntityListing.
+ :param last_uri: The last_uri of this UserEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/user_language_entity_listing.py b/build/PureCloudPlatformClientV2/models/user_language_entity_listing.py
index b3006deb7..218db17cc 100644
--- a/build/PureCloudPlatformClientV2/models/user_language_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/user_language_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this UserLanguageEntityListing.
+ Gets the first_uri of this UserLanguageEntityListing.
- :return: The last_uri of this UserLanguageEntityListing.
+ :return: The first_uri of this UserLanguageEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this UserLanguageEntityListing.
+ Sets the first_uri of this UserLanguageEntityListing.
- :param last_uri: The last_uri of this UserLanguageEntityListing.
+ :param first_uri: The first_uri of this UserLanguageEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this UserLanguageEntityListing.
+ Gets the last_uri of this UserLanguageEntityListing.
- :return: The first_uri of this UserLanguageEntityListing.
+ :return: The last_uri of this UserLanguageEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this UserLanguageEntityListing.
+ Sets the last_uri of this UserLanguageEntityListing.
- :param first_uri: The first_uri of this UserLanguageEntityListing.
+ :param last_uri: The last_uri of this UserLanguageEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/user_profile_entity_listing.py b/build/PureCloudPlatformClientV2/models/user_profile_entity_listing.py
index 23d362be3..324ef2a53 100644
--- a/build/PureCloudPlatformClientV2/models/user_profile_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/user_profile_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this UserProfileEntityListing.
+ Gets the first_uri of this UserProfileEntityListing.
- :return: The last_uri of this UserProfileEntityListing.
+ :return: The first_uri of this UserProfileEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this UserProfileEntityListing.
+ Sets the first_uri of this UserProfileEntityListing.
- :param last_uri: The last_uri of this UserProfileEntityListing.
+ :param first_uri: The first_uri of this UserProfileEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this UserProfileEntityListing.
+ Gets the last_uri of this UserProfileEntityListing.
- :return: The first_uri of this UserProfileEntityListing.
+ :return: The last_uri of this UserProfileEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this UserProfileEntityListing.
+ Sets the last_uri of this UserProfileEntityListing.
- :param first_uri: The first_uri of this UserProfileEntityListing.
+ :param last_uri: The last_uri of this UserProfileEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/user_queue_entity_listing.py b/build/PureCloudPlatformClientV2/models/user_queue_entity_listing.py
index 2653af050..e73c5579b 100644
--- a/build/PureCloudPlatformClientV2/models/user_queue_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/user_queue_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this UserQueueEntityListing.
+ Gets the first_uri of this UserQueueEntityListing.
- :return: The last_uri of this UserQueueEntityListing.
+ :return: The first_uri of this UserQueueEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this UserQueueEntityListing.
+ Sets the first_uri of this UserQueueEntityListing.
- :param last_uri: The last_uri of this UserQueueEntityListing.
+ :param first_uri: The first_uri of this UserQueueEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this UserQueueEntityListing.
+ Gets the last_uri of this UserQueueEntityListing.
- :return: The first_uri of this UserQueueEntityListing.
+ :return: The last_uri of this UserQueueEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this UserQueueEntityListing.
+ Sets the last_uri of this UserQueueEntityListing.
- :param first_uri: The first_uri of this UserQueueEntityListing.
+ :param last_uri: The last_uri of this UserQueueEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/user_recording_entity_listing.py b/build/PureCloudPlatformClientV2/models/user_recording_entity_listing.py
index b286e0af5..2b74a2f1c 100644
--- a/build/PureCloudPlatformClientV2/models/user_recording_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/user_recording_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this UserRecordingEntityListing.
+ Gets the first_uri of this UserRecordingEntityListing.
- :return: The last_uri of this UserRecordingEntityListing.
+ :return: The first_uri of this UserRecordingEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this UserRecordingEntityListing.
+ Sets the first_uri of this UserRecordingEntityListing.
- :param last_uri: The last_uri of this UserRecordingEntityListing.
+ :param first_uri: The first_uri of this UserRecordingEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this UserRecordingEntityListing.
+ Gets the last_uri of this UserRecordingEntityListing.
- :return: The first_uri of this UserRecordingEntityListing.
+ :return: The last_uri of this UserRecordingEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this UserRecordingEntityListing.
+ Sets the last_uri of this UserRecordingEntityListing.
- :param first_uri: The first_uri of this UserRecordingEntityListing.
+ :param last_uri: The last_uri of this UserRecordingEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/user_skill_entity_listing.py b/build/PureCloudPlatformClientV2/models/user_skill_entity_listing.py
index d96727bae..7b3eb21ca 100644
--- a/build/PureCloudPlatformClientV2/models/user_skill_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/user_skill_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this UserSkillEntityListing.
+ Gets the first_uri of this UserSkillEntityListing.
- :return: The last_uri of this UserSkillEntityListing.
+ :return: The first_uri of this UserSkillEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this UserSkillEntityListing.
+ Sets the first_uri of this UserSkillEntityListing.
- :param last_uri: The last_uri of this UserSkillEntityListing.
+ :param first_uri: The first_uri of this UserSkillEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this UserSkillEntityListing.
+ Gets the last_uri of this UserSkillEntityListing.
- :return: The first_uri of this UserSkillEntityListing.
+ :return: The last_uri of this UserSkillEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this UserSkillEntityListing.
+ Sets the last_uri of this UserSkillEntityListing.
- :param first_uri: The first_uri of this UserSkillEntityListing.
+ :param last_uri: The last_uri of this UserSkillEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/user_start_detail_event_topic_user_start_event.py b/build/PureCloudPlatformClientV2/models/user_start_detail_event_topic_user_start_event.py
index 608cc7c35..6d40a81cd 100644
--- a/build/PureCloudPlatformClientV2/models/user_start_detail_event_topic_user_start_event.py
+++ b/build/PureCloudPlatformClientV2/models/user_start_detail_event_topic_user_start_event.py
@@ -509,7 +509,7 @@ def message_type(self, message_type: str) -> None:
"""
if isinstance(message_type, int):
message_type = str(message_type)
- allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM"]
+ allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM", "APPLE"]
if message_type.lower() not in map(str.lower, allowed_values):
# print("Invalid value for message_type -> " + message_type)
self._message_type = "outdated_sdk_version"
diff --git a/build/PureCloudPlatformClientV2/models/utilization_label_entity_listing.py b/build/PureCloudPlatformClientV2/models/utilization_label_entity_listing.py
index 089ac9b95..f47c0a844 100644
--- a/build/PureCloudPlatformClientV2/models/utilization_label_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/utilization_label_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this UtilizationLabelEntityListing.
+ Gets the first_uri of this UtilizationLabelEntityListing.
- :return: The last_uri of this UtilizationLabelEntityListing.
+ :return: The first_uri of this UtilizationLabelEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this UtilizationLabelEntityListing.
+ Sets the first_uri of this UtilizationLabelEntityListing.
- :param last_uri: The last_uri of this UtilizationLabelEntityListing.
+ :param first_uri: The first_uri of this UtilizationLabelEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this UtilizationLabelEntityListing.
+ Gets the last_uri of this UtilizationLabelEntityListing.
- :return: The first_uri of this UtilizationLabelEntityListing.
+ :return: The last_uri of this UtilizationLabelEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this UtilizationLabelEntityListing.
+ Sets the last_uri of this UtilizationLabelEntityListing.
- :param first_uri: The first_uri of this UtilizationLabelEntityListing.
+ :param last_uri: The last_uri of this UtilizationLabelEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/utilization_tag_entity_listing.py b/build/PureCloudPlatformClientV2/models/utilization_tag_entity_listing.py
index 871f78167..ed4767fd4 100644
--- a/build/PureCloudPlatformClientV2/models/utilization_tag_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/utilization_tag_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this UtilizationTagEntityListing.
+ Gets the first_uri of this UtilizationTagEntityListing.
- :return: The last_uri of this UtilizationTagEntityListing.
+ :return: The first_uri of this UtilizationTagEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this UtilizationTagEntityListing.
+ Sets the first_uri of this UtilizationTagEntityListing.
- :param last_uri: The last_uri of this UtilizationTagEntityListing.
+ :param first_uri: The first_uri of this UtilizationTagEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this UtilizationTagEntityListing.
+ Gets the last_uri of this UtilizationTagEntityListing.
- :return: The first_uri of this UtilizationTagEntityListing.
+ :return: The last_uri of this UtilizationTagEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this UtilizationTagEntityListing.
+ Sets the last_uri of this UtilizationTagEntityListing.
- :param first_uri: The first_uri of this UtilizationTagEntityListing.
+ :param last_uri: The last_uri of this UtilizationTagEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/voicemail_message_entity_listing.py b/build/PureCloudPlatformClientV2/models/voicemail_message_entity_listing.py
index c5c9a5792..0ae5d020a 100644
--- a/build/PureCloudPlatformClientV2/models/voicemail_message_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/voicemail_message_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this VoicemailMessageEntityListing.
+ Gets the first_uri of this VoicemailMessageEntityListing.
- :return: The last_uri of this VoicemailMessageEntityListing.
+ :return: The first_uri of this VoicemailMessageEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this VoicemailMessageEntityListing.
+ Sets the first_uri of this VoicemailMessageEntityListing.
- :param last_uri: The last_uri of this VoicemailMessageEntityListing.
+ :param first_uri: The first_uri of this VoicemailMessageEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this VoicemailMessageEntityListing.
+ Gets the last_uri of this VoicemailMessageEntityListing.
- :return: The first_uri of this VoicemailMessageEntityListing.
+ :return: The last_uri of this VoicemailMessageEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this VoicemailMessageEntityListing.
+ Sets the last_uri of this VoicemailMessageEntityListing.
- :param first_uri: The first_uri of this VoicemailMessageEntityListing.
+ :param last_uri: The last_uri of this VoicemailMessageEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/web_chat_member_info_entity_list.py b/build/PureCloudPlatformClientV2/models/web_chat_member_info_entity_list.py
index a3e7eb78c..865e46904 100644
--- a/build/PureCloudPlatformClientV2/models/web_chat_member_info_entity_list.py
+++ b/build/PureCloudPlatformClientV2/models/web_chat_member_info_entity_list.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this WebChatMemberInfoEntityList.
+ Gets the first_uri of this WebChatMemberInfoEntityList.
- :return: The last_uri of this WebChatMemberInfoEntityList.
+ :return: The first_uri of this WebChatMemberInfoEntityList.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this WebChatMemberInfoEntityList.
+ Sets the first_uri of this WebChatMemberInfoEntityList.
- :param last_uri: The last_uri of this WebChatMemberInfoEntityList.
+ :param first_uri: The first_uri of this WebChatMemberInfoEntityList.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this WebChatMemberInfoEntityList.
+ Gets the last_uri of this WebChatMemberInfoEntityList.
- :return: The first_uri of this WebChatMemberInfoEntityList.
+ :return: The last_uri of this WebChatMemberInfoEntityList.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this WebChatMemberInfoEntityList.
+ Sets the last_uri of this WebChatMemberInfoEntityList.
- :param first_uri: The first_uri of this WebChatMemberInfoEntityList.
+ :param last_uri: The last_uri of this WebChatMemberInfoEntityList.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/whats_app_integration_entity_listing.py b/build/PureCloudPlatformClientV2/models/whats_app_integration_entity_listing.py
index e0fbd57f7..82b7709cc 100644
--- a/build/PureCloudPlatformClientV2/models/whats_app_integration_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/whats_app_integration_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this WhatsAppIntegrationEntityListing.
+ Gets the first_uri of this WhatsAppIntegrationEntityListing.
- :return: The last_uri of this WhatsAppIntegrationEntityListing.
+ :return: The first_uri of this WhatsAppIntegrationEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this WhatsAppIntegrationEntityListing.
+ Sets the first_uri of this WhatsAppIntegrationEntityListing.
- :param last_uri: The last_uri of this WhatsAppIntegrationEntityListing.
+ :param first_uri: The first_uri of this WhatsAppIntegrationEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this WhatsAppIntegrationEntityListing.
+ Gets the last_uri of this WhatsAppIntegrationEntityListing.
- :return: The first_uri of this WhatsAppIntegrationEntityListing.
+ :return: The last_uri of this WhatsAppIntegrationEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this WhatsAppIntegrationEntityListing.
+ Sets the last_uri of this WhatsAppIntegrationEntityListing.
- :param first_uri: The first_uri of this WhatsAppIntegrationEntityListing.
+ :param last_uri: The last_uri of this WhatsAppIntegrationEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/workitem_flow_reference.py b/build/PureCloudPlatformClientV2/models/workitem_flow_reference.py
new file mode 100644
index 000000000..e1c61b5ca
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/workitem_flow_reference.py
@@ -0,0 +1,193 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+
+class WorkitemFlowReference(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ WorkitemFlowReference - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'id': 'str',
+ 'name': 'str',
+ 'self_uri': 'str'
+ }
+
+ self.attribute_map = {
+ 'id': 'id',
+ 'name': 'name',
+ 'self_uri': 'selfUri'
+ }
+
+ self._id = None
+ self._name = None
+ self._self_uri = None
+
+ @property
+ def id(self) -> str:
+ """
+ Gets the id of this WorkitemFlowReference.
+ The globally unique identifier for the object.
+
+ :return: The id of this WorkitemFlowReference.
+ :rtype: str
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id: str) -> None:
+ """
+ Sets the id of this WorkitemFlowReference.
+ The globally unique identifier for the object.
+
+ :param id: The id of this WorkitemFlowReference.
+ :type: str
+ """
+
+
+ self._id = id
+
+ @property
+ def name(self) -> str:
+ """
+ Gets the name of this WorkitemFlowReference.
+
+
+ :return: The name of this WorkitemFlowReference.
+ :rtype: str
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name: str) -> None:
+ """
+ Sets the name of this WorkitemFlowReference.
+
+
+ :param name: The name of this WorkitemFlowReference.
+ :type: str
+ """
+
+
+ self._name = name
+
+ @property
+ def self_uri(self) -> str:
+ """
+ Gets the self_uri of this WorkitemFlowReference.
+ The URI for this object
+
+ :return: The self_uri of this WorkitemFlowReference.
+ :rtype: str
+ """
+ return self._self_uri
+
+ @self_uri.setter
+ def self_uri(self, self_uri: str) -> None:
+ """
+ Sets the self_uri of this WorkitemFlowReference.
+ The URI for this object
+
+ :param self_uri: The self_uri of this WorkitemFlowReference.
+ :type: str
+ """
+
+
+ self._self_uri = self_uri
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/workitem_rule_settings.py b/build/PureCloudPlatformClientV2/models/workitem_rule_settings.py
new file mode 100644
index 000000000..b2156ca06
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/workitem_rule_settings.py
@@ -0,0 +1,114 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+
+class WorkitemRuleSettings(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ WorkitemRuleSettings - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+
+ }
+
+ self.attribute_map = {
+
+ }
+
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/workspace_entity_listing.py b/build/PureCloudPlatformClientV2/models/workspace_entity_listing.py
index 8d5219092..0f50a461d 100644
--- a/build/PureCloudPlatformClientV2/models/workspace_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/workspace_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this WorkspaceEntityListing.
+ Gets the first_uri of this WorkspaceEntityListing.
- :return: The last_uri of this WorkspaceEntityListing.
+ :return: The first_uri of this WorkspaceEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this WorkspaceEntityListing.
+ Sets the first_uri of this WorkspaceEntityListing.
- :param last_uri: The last_uri of this WorkspaceEntityListing.
+ :param first_uri: The first_uri of this WorkspaceEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this WorkspaceEntityListing.
+ Gets the last_uri of this WorkspaceEntityListing.
- :return: The first_uri of this WorkspaceEntityListing.
+ :return: The last_uri of this WorkspaceEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this WorkspaceEntityListing.
+ Sets the last_uri of this WorkspaceEntityListing.
- :param first_uri: The first_uri of this WorkspaceEntityListing.
+ :param last_uri: The last_uri of this WorkspaceEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/workspace_member_entity_listing.py b/build/PureCloudPlatformClientV2/models/workspace_member_entity_listing.py
index dfefef02a..3bd2f6ded 100644
--- a/build/PureCloudPlatformClientV2/models/workspace_member_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/workspace_member_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this WorkspaceMemberEntityListing.
+ Gets the first_uri of this WorkspaceMemberEntityListing.
- :return: The last_uri of this WorkspaceMemberEntityListing.
+ :return: The first_uri of this WorkspaceMemberEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this WorkspaceMemberEntityListing.
+ Sets the first_uri of this WorkspaceMemberEntityListing.
- :param last_uri: The last_uri of this WorkspaceMemberEntityListing.
+ :param first_uri: The first_uri of this WorkspaceMemberEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this WorkspaceMemberEntityListing.
+ Gets the last_uri of this WorkspaceMemberEntityListing.
- :return: The first_uri of this WorkspaceMemberEntityListing.
+ :return: The last_uri of this WorkspaceMemberEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this WorkspaceMemberEntityListing.
+ Sets the last_uri of this WorkspaceMemberEntityListing.
- :param first_uri: The first_uri of this WorkspaceMemberEntityListing.
+ :param last_uri: The last_uri of this WorkspaceMemberEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/wrapup_code_entity_listing.py b/build/PureCloudPlatformClientV2/models/wrapup_code_entity_listing.py
index 8b69441a3..56c55b0b6 100644
--- a/build/PureCloudPlatformClientV2/models/wrapup_code_entity_listing.py
+++ b/build/PureCloudPlatformClientV2/models/wrapup_code_entity_listing.py
@@ -54,8 +54,8 @@ def __init__(self) -> None:
'page_size': 'int',
'page_number': 'int',
'total': 'int',
- 'last_uri': 'str',
'first_uri': 'str',
+ 'last_uri': 'str',
'self_uri': 'str',
'next_uri': 'str',
'previous_uri': 'str',
@@ -67,8 +67,8 @@ def __init__(self) -> None:
'page_size': 'pageSize',
'page_number': 'pageNumber',
'total': 'total',
- 'last_uri': 'lastUri',
'first_uri': 'firstUri',
+ 'last_uri': 'lastUri',
'self_uri': 'selfUri',
'next_uri': 'nextUri',
'previous_uri': 'previousUri',
@@ -79,8 +79,8 @@ def __init__(self) -> None:
self._page_size = None
self._page_number = None
self._total = None
- self._last_uri = None
self._first_uri = None
+ self._last_uri = None
self._self_uri = None
self._next_uri = None
self._previous_uri = None
@@ -183,52 +183,52 @@ def total(self, total: int) -> None:
self._total = total
@property
- def last_uri(self) -> str:
+ def first_uri(self) -> str:
"""
- Gets the last_uri of this WrapupCodeEntityListing.
+ Gets the first_uri of this WrapupCodeEntityListing.
- :return: The last_uri of this WrapupCodeEntityListing.
+ :return: The first_uri of this WrapupCodeEntityListing.
:rtype: str
"""
- return self._last_uri
+ return self._first_uri
- @last_uri.setter
- def last_uri(self, last_uri: str) -> None:
+ @first_uri.setter
+ def first_uri(self, first_uri: str) -> None:
"""
- Sets the last_uri of this WrapupCodeEntityListing.
+ Sets the first_uri of this WrapupCodeEntityListing.
- :param last_uri: The last_uri of this WrapupCodeEntityListing.
+ :param first_uri: The first_uri of this WrapupCodeEntityListing.
:type: str
"""
- self._last_uri = last_uri
+ self._first_uri = first_uri
@property
- def first_uri(self) -> str:
+ def last_uri(self) -> str:
"""
- Gets the first_uri of this WrapupCodeEntityListing.
+ Gets the last_uri of this WrapupCodeEntityListing.
- :return: The first_uri of this WrapupCodeEntityListing.
+ :return: The last_uri of this WrapupCodeEntityListing.
:rtype: str
"""
- return self._first_uri
+ return self._last_uri
- @first_uri.setter
- def first_uri(self, first_uri: str) -> None:
+ @last_uri.setter
+ def last_uri(self, last_uri: str) -> None:
"""
- Sets the first_uri of this WrapupCodeEntityListing.
+ Sets the last_uri of this WrapupCodeEntityListing.
- :param first_uri: The first_uri of this WrapupCodeEntityListing.
+ :param last_uri: The last_uri of this WrapupCodeEntityListing.
:type: str
"""
- self._first_uri = first_uri
+ self._last_uri = last_uri
@property
def self_uri(self) -> str:
diff --git a/build/PureCloudPlatformClientV2/models/wrapup_code_prediction_config.py b/build/PureCloudPlatformClientV2/models/wrapup_code_prediction_config.py
new file mode 100644
index 000000000..c0b69c0b5
--- /dev/null
+++ b/build/PureCloudPlatformClientV2/models/wrapup_code_prediction_config.py
@@ -0,0 +1,139 @@
+# coding: utf-8
+
+"""
+Copyright 2016 SmartBear Software
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Ref: https://github.com/swagger-api/swagger-codegen
+"""
+
+from datetime import datetime
+from datetime import date
+from pprint import pformat
+from six import iteritems
+import re
+import json
+
+from ..utils import sanitize_for_serialization
+
+# type hinting support
+from typing import TYPE_CHECKING
+from typing import List
+from typing import Dict
+
+
+class WrapupCodePredictionConfig(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+ def __init__(self) -> None:
+ """
+ WrapupCodePredictionConfig - a model defined in Swagger
+
+ :param dict swaggerTypes: The key is attribute name
+ and the value is attribute type.
+ :param dict attributeMap: The key is attribute name
+ and the value is json key in definition.
+ """
+ self.swagger_types = {
+ 'enabled': 'bool'
+ }
+
+ self.attribute_map = {
+ 'enabled': 'enabled'
+ }
+
+ self._enabled = None
+
+ @property
+ def enabled(self) -> bool:
+ """
+ Gets the enabled of this WrapupCodePredictionConfig.
+ Copilot generated wrapup code prediction is enabled.
+
+ :return: The enabled of this WrapupCodePredictionConfig.
+ :rtype: bool
+ """
+ return self._enabled
+
+ @enabled.setter
+ def enabled(self, enabled: bool) -> None:
+ """
+ Sets the enabled of this WrapupCodePredictionConfig.
+ Copilot generated wrapup code prediction is enabled.
+
+ :param enabled: The enabled of this WrapupCodePredictionConfig.
+ :type: bool
+ """
+
+
+ self._enabled = enabled
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_json(self):
+ """
+ Returns the model as raw JSON
+ """
+ return json.dumps(sanitize_for_serialization(self.to_dict()))
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
+
diff --git a/build/PureCloudPlatformClientV2/models/wrapup_detail_event_topic_wrapup_event.py b/build/PureCloudPlatformClientV2/models/wrapup_detail_event_topic_wrapup_event.py
index 1a3595fb2..04ddb78d7 100644
--- a/build/PureCloudPlatformClientV2/models/wrapup_detail_event_topic_wrapup_event.py
+++ b/build/PureCloudPlatformClientV2/models/wrapup_detail_event_topic_wrapup_event.py
@@ -512,7 +512,7 @@ def message_type(self, message_type: str) -> None:
"""
if isinstance(message_type, int):
message_type = str(message_type)
- allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM"]
+ allowed_values = ["UNKNOWN", "SMS", "TWITTER", "FACEBOOK", "LINE", "WHATSAPP", "WEBMESSAGING", "OPEN", "INSTAGRAM", "APPLE"]
if message_type.lower() not in map(str.lower, allowed_values):
# print("Invalid value for message_type -> " + message_type)
self._message_type = "outdated_sdk_version"
diff --git a/build/docs/AcceleratorList.md b/build/docs/AcceleratorList.md
index 1f6c39560..abb0f1802 100644
--- a/build/docs/AcceleratorList.md
+++ b/build/docs/AcceleratorList.md
@@ -11,8 +11,8 @@ title: AcceleratorList
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/AcdEndDetailEventTopicAcdEndEvent.md b/build/docs/AcdEndDetailEventTopicAcdEndEvent.md
index 2e3ab5359..a3bf6a643 100644
--- a/build/docs/AcdEndDetailEventTopicAcdEndEvent.md
+++ b/build/docs/AcdEndDetailEventTopicAcdEndEvent.md
@@ -37,6 +37,8 @@ title: AcdEndDetailEventTopicAcdEndEvent
| **connected_duration_ms** | **int** | | [optional] |
| **conversation_external_contact_ids** | **list[str]** | | [optional] |
| **conversation_external_organization_ids** | **list[str]** | | [optional] |
+| **utilization_label** | **str** | | [optional] |
+| **flow_type** | **str** | | [optional] |
{: class="table table-striped"}
diff --git a/build/docs/AcdStartDetailEventTopicAcdStartEvent.md b/build/docs/AcdStartDetailEventTopicAcdStartEvent.md
index e8f5003b9..c0bb4b69d 100644
--- a/build/docs/AcdStartDetailEventTopicAcdStartEvent.md
+++ b/build/docs/AcdStartDetailEventTopicAcdStartEvent.md
@@ -27,6 +27,9 @@ title: AcdStartDetailEventTopicAcdStartEvent
| **division_id** | **str** | | [optional] |
| **conversation_external_contact_ids** | **list[str]** | | [optional] |
| **conversation_external_organization_ids** | **list[str]** | | [optional] |
+| **utilization_label** | **str** | | [optional] |
+| **routing_priority** | **int** | | [optional] |
+| **requested_routing_skill_ids** | **list[str]** | | [optional] |
{: class="table table-striped"}
diff --git a/build/docs/ActionCertificateListing.md b/build/docs/ActionCertificateListing.md
index ffb551d74..faa67ccb1 100644
--- a/build/docs/ActionCertificateListing.md
+++ b/build/docs/ActionCertificateListing.md
@@ -11,8 +11,8 @@ title: ActionCertificateListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ActionEntityListing.md b/build/docs/ActionEntityListing.md
index f0ed0d920..cb91182c3 100644
--- a/build/docs/ActionEntityListing.md
+++ b/build/docs/ActionEntityListing.md
@@ -11,8 +11,8 @@ title: ActionEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ActionMapListing.md b/build/docs/ActionMapListing.md
index a909696ff..ad397cba5 100644
--- a/build/docs/ActionMapListing.md
+++ b/build/docs/ActionMapListing.md
@@ -11,8 +11,8 @@ title: ActionMapListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ActionTargetListing.md b/build/docs/ActionTargetListing.md
index 20159b44e..65fec1256 100644
--- a/build/docs/ActionTargetListing.md
+++ b/build/docs/ActionTargetListing.md
@@ -11,8 +11,8 @@ title: ActionTargetListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ActionTemplateListing.md b/build/docs/ActionTemplateListing.md
index 8d2d014e0..2969fafb4 100644
--- a/build/docs/ActionTemplateListing.md
+++ b/build/docs/ActionTemplateListing.md
@@ -11,8 +11,8 @@ title: ActionTemplateListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ActivityCodesReference.md b/build/docs/ActivityCodesReference.md
index 301e40850..0dee86bd3 100644
--- a/build/docs/ActivityCodesReference.md
+++ b/build/docs/ActivityCodesReference.md
@@ -7,7 +7,6 @@ title: ActivityCodesReference
|Name | Type | Description | Notes|
|------------ | ------------- | ------------- | -------------|
-| **id** | **str** | The globally unique identifier for the object. | [optional] |
| **ids** | **list[str]** | The IDs of activity codes | [optional] |
| **self_uri** | **str** | The URI for this object | [optional] |
{: class="table table-striped"}
diff --git a/build/docs/AgentActivityEntityListing.md b/build/docs/AgentActivityEntityListing.md
index 1cb67a6ba..8cc27db8c 100644
--- a/build/docs/AgentActivityEntityListing.md
+++ b/build/docs/AgentActivityEntityListing.md
@@ -11,8 +11,8 @@ title: AgentActivityEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/AgentAssistantsApi.md b/build/docs/AgentAssistantsApi.md
new file mode 100644
index 000000000..760f2baeb
--- /dev/null
+++ b/build/docs/AgentAssistantsApi.md
@@ -0,0 +1,651 @@
+---
+title: AgentAssistantsApi
+---
+
+## PureCloudPlatformClientV2.AgentAssistantsApi
+
+All URIs are relative to *https://api.mypurecloud.com*
+
+|Method | Description|
+|------------- | -------------|
+|[**delete_assistant**](AgentAssistantsApi.html#delete_assistant) | Delete an assistant.|
+|[**delete_assistant_queue**](AgentAssistantsApi.html#delete_assistant_queue) | Disassociate a queue from an assistant.|
+|[**delete_assistant_queues**](AgentAssistantsApi.html#delete_assistant_queues) | Disassociate the queues from an assistant for the given assistant ID and queue IDs.|
+|[**get_assistant**](AgentAssistantsApi.html#get_assistant) | Get an assistant.|
+|[**get_assistant_queue**](AgentAssistantsApi.html#get_assistant_queue) | Get queue Information for an assistant.|
+|[**get_assistant_queues**](AgentAssistantsApi.html#get_assistant_queues) | Get all the queues associated with an assistant.|
+|[**get_assistants**](AgentAssistantsApi.html#get_assistants) | Get all assistants.|
+|[**get_assistants_queues**](AgentAssistantsApi.html#get_assistants_queues) | Get all queues assigned to any assistant.|
+|[**patch_assistant**](AgentAssistantsApi.html#patch_assistant) | Update an assistant.|
+|[**patch_assistant_queues**](AgentAssistantsApi.html#patch_assistant_queues) | Update Queues for an Assistant.|
+|[**post_assistants**](AgentAssistantsApi.html#post_assistants) | Create an Assistant.|
+|[**put_assistant_queue**](AgentAssistantsApi.html#put_assistant_queue) | Create a queue assistant association.|
+{: class="table table-striped"}
+
+
+
+## delete_assistant(assistant_id)
+
+
+
+Delete an assistant.
+
+Wraps DELETE /api/v2/assistants/{assistantId}
+
+Requires ALL permissions:
+
+* assistants:assistant:delete
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.AgentAssistantsApi()
+assistant_id = 'assistant_id_example' # str | Assistant ID
+
+try:
+ # Delete an assistant.
+ api_instance.delete_assistant(assistant_id)
+except ApiException as e:
+ print("Exception when calling AgentAssistantsApi->delete_assistant: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **assistant_id** | **str**| Assistant ID | |
+{: class="table table-striped"}
+
+### Return type
+
+void (empty response body)
+
+
+
+## delete_assistant_queue(assistant_id, queue_id)
+
+
+
+Disassociate a queue from an assistant.
+
+Wraps DELETE /api/v2/assistants/{assistantId}/queues/{queueId}
+
+Requires ALL permissions:
+
+* assistants:queue:delete
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.AgentAssistantsApi()
+assistant_id = 'assistant_id_example' # str | Assistant ID
+queue_id = 'queue_id_example' # str | Queue ID
+
+try:
+ # Disassociate a queue from an assistant.
+ api_instance.delete_assistant_queue(assistant_id, queue_id)
+except ApiException as e:
+ print("Exception when calling AgentAssistantsApi->delete_assistant_queue: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **assistant_id** | **str**| Assistant ID | |
+| **queue_id** | **str**| Queue ID | |
+{: class="table table-striped"}
+
+### Return type
+
+void (empty response body)
+
+
+
+## delete_assistant_queues(assistant_id, queue_ids=queue_ids)
+
+
+
+Disassociate the queues from an assistant for the given assistant ID and queue IDs.
+
+Wraps DELETE /api/v2/assistants/{assistantId}/queues
+
+Requires ALL permissions:
+
+* assistants:queue:delete
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.AgentAssistantsApi()
+assistant_id = 'assistant_id_example' # str | Assistant ID
+queue_ids = 'queue_ids_example' # str | Comma-separated identifiers of the queues that need to be deleted. (optional)
+
+try:
+ # Disassociate the queues from an assistant for the given assistant ID and queue IDs.
+ api_instance.delete_assistant_queues(assistant_id, queue_ids=queue_ids)
+except ApiException as e:
+ print("Exception when calling AgentAssistantsApi->delete_assistant_queues: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **assistant_id** | **str**| Assistant ID | |
+| **queue_ids** | **str**| Comma-separated identifiers of the queues that need to be deleted. | [optional] |
+{: class="table table-striped"}
+
+### Return type
+
+void (empty response body)
+
+
+
+## [**Assistant**](Assistant.html) get_assistant(assistant_id, expand=expand)
+
+
+
+Get an assistant.
+
+Wraps GET /api/v2/assistants/{assistantId}
+
+Requires ALL permissions:
+
+* assistants:assistant:view
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.AgentAssistantsApi()
+assistant_id = 'assistant_id_example' # str | Assistant ID
+expand = 'expand_example' # str | Which fields, if any, to expand. (optional)
+
+try:
+ # Get an assistant.
+ api_response = api_instance.get_assistant(assistant_id, expand=expand)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling AgentAssistantsApi->get_assistant: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **assistant_id** | **str**| Assistant ID | |
+| **expand** | **str**| Which fields, if any, to expand. | [optional]
**Values**: copilot |
+{: class="table table-striped"}
+
+### Return type
+
+[**Assistant**](Assistant.html)
+
+
+
+## [**AssistantQueue**](AssistantQueue.html) get_assistant_queue(assistant_id, queue_id, expand=expand)
+
+
+
+Get queue Information for an assistant.
+
+Wraps GET /api/v2/assistants/{assistantId}/queues/{queueId}
+
+Requires ALL permissions:
+
+* assistants:queue:view
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.AgentAssistantsApi()
+assistant_id = 'assistant_id_example' # str | Assistant ID
+queue_id = 'queue_id_example' # str | Queue ID
+expand = 'expand_example' # str | Which fields, if any, to expand. (optional)
+
+try:
+ # Get queue Information for an assistant.
+ api_response = api_instance.get_assistant_queue(assistant_id, queue_id, expand=expand)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling AgentAssistantsApi->get_assistant_queue: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **assistant_id** | **str**| Assistant ID | |
+| **queue_id** | **str**| Queue ID | |
+| **expand** | **str**| Which fields, if any, to expand. | [optional]
**Values**: assistant |
+{: class="table table-striped"}
+
+### Return type
+
+[**AssistantQueue**](AssistantQueue.html)
+
+
+
+## [**AssistantQueueListing**](AssistantQueueListing.html) get_assistant_queues(assistant_id, before=before, after=after, page_size=page_size, expand=expand)
+
+
+
+Get all the queues associated with an assistant.
+
+Wraps GET /api/v2/assistants/{assistantId}/queues
+
+Requires ALL permissions:
+
+* assistants:queue:view
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.AgentAssistantsApi()
+assistant_id = 'assistant_id_example' # str | Assistant ID
+before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional)
+after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional)
+page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional)
+expand = 'expand_example' # str | Which fields, if any, to expand. (optional)
+
+try:
+ # Get all the queues associated with an assistant.
+ api_response = api_instance.get_assistant_queues(assistant_id, before=before, after=after, page_size=page_size, expand=expand)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling AgentAssistantsApi->get_assistant_queues: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **assistant_id** | **str**| Assistant ID | |
+| **before** | **str**| The cursor that points to the start of the set of entities that has been returned. | [optional] |
+| **after** | **str**| The cursor that points to the end of the set of entities that has been returned. | [optional] |
+| **page_size** | **str**| Number of entities to return. Maximum of 200. | [optional] |
+| **expand** | **str**| Which fields, if any, to expand. | [optional]
**Values**: assistant |
+{: class="table table-striped"}
+
+### Return type
+
+[**AssistantQueueListing**](AssistantQueueListing.html)
+
+
+
+## [**AssistantListing**](AssistantListing.html) get_assistants(before=before, after=after, limit=limit, page_size=page_size, name=name)
+
+
+
+Get all assistants.
+
+Wraps GET /api/v2/assistants
+
+Requires ALL permissions:
+
+* assistants:assistant:view
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.AgentAssistantsApi()
+before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional)
+after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional)
+limit = 'limit_example' # str | Number of entities to return. Maximum of 200. Deprecated in favour of pageSize (optional)
+page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional)
+name = 'name_example' # str | Return the assistant by the given name. (optional)
+
+try:
+ # Get all assistants.
+ api_response = api_instance.get_assistants(before=before, after=after, limit=limit, page_size=page_size, name=name)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling AgentAssistantsApi->get_assistants: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **before** | **str**| The cursor that points to the start of the set of entities that has been returned. | [optional] |
+| **after** | **str**| The cursor that points to the end of the set of entities that has been returned. | [optional] |
+| **limit** | **str**| Number of entities to return. Maximum of 200. Deprecated in favour of pageSize | [optional] |
+| **page_size** | **str**| Number of entities to return. Maximum of 200. | [optional] |
+| **name** | **str**| Return the assistant by the given name. | [optional] |
+{: class="table table-striped"}
+
+### Return type
+
+[**AssistantListing**](AssistantListing.html)
+
+
+
+## [**AssistantQueueListing**](AssistantQueueListing.html) get_assistants_queues(before=before, after=after, page_size=page_size, queue_ids=queue_ids, expand=expand)
+
+
+
+Get all queues assigned to any assistant.
+
+Wraps GET /api/v2/assistants/queues
+
+Requires ALL permissions:
+
+* assistants:queue:view
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.AgentAssistantsApi()
+before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional)
+after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional)
+page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional)
+queue_ids = 'queue_ids_example' # str | Comma-separated identifiers of the queues that need to be retrieved. (optional)
+expand = 'expand_example' # str | Which fields, if any, to expand. (optional)
+
+try:
+ # Get all queues assigned to any assistant.
+ api_response = api_instance.get_assistants_queues(before=before, after=after, page_size=page_size, queue_ids=queue_ids, expand=expand)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling AgentAssistantsApi->get_assistants_queues: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **before** | **str**| The cursor that points to the start of the set of entities that has been returned. | [optional] |
+| **after** | **str**| The cursor that points to the end of the set of entities that has been returned. | [optional] |
+| **page_size** | **str**| Number of entities to return. Maximum of 200. | [optional] |
+| **queue_ids** | **str**| Comma-separated identifiers of the queues that need to be retrieved. | [optional] |
+| **expand** | **str**| Which fields, if any, to expand. | [optional]
**Values**: assistant |
+{: class="table table-striped"}
+
+### Return type
+
+[**AssistantQueueListing**](AssistantQueueListing.html)
+
+
+
+## [**Assistant**](Assistant.html) patch_assistant(assistant_id, body)
+
+
+
+Update an assistant.
+
+Wraps PATCH /api/v2/assistants/{assistantId}
+
+Requires ALL permissions:
+
+* assistants:assistant:edit
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.AgentAssistantsApi()
+assistant_id = 'assistant_id_example' # str | Assistant ID
+body = PureCloudPlatformClientV2.Assistant() # Assistant |
+
+try:
+ # Update an assistant.
+ api_response = api_instance.patch_assistant(assistant_id, body)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling AgentAssistantsApi->patch_assistant: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **assistant_id** | **str**| Assistant ID | |
+| **body** | [**Assistant**](Assistant.html)| | |
+{: class="table table-striped"}
+
+### Return type
+
+[**Assistant**](Assistant.html)
+
+
+
+## [**AssistantQueueListing**](AssistantQueueListing.html) patch_assistant_queues(assistant_id, body)
+
+
+
+Update Queues for an Assistant.
+
+Wraps PATCH /api/v2/assistants/{assistantId}/queues
+
+Requires ALL permissions:
+
+* assistants:queue:edit
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.AgentAssistantsApi()
+assistant_id = 'assistant_id_example' # str | Assistant ID
+body = [PureCloudPlatformClientV2.AssistantQueue()] # list[AssistantQueue] |
+
+try:
+ # Update Queues for an Assistant.
+ api_response = api_instance.patch_assistant_queues(assistant_id, body)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling AgentAssistantsApi->patch_assistant_queues: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **assistant_id** | **str**| Assistant ID | |
+| **body** | [**list[AssistantQueue]**](AssistantQueue.html)| | |
+{: class="table table-striped"}
+
+### Return type
+
+[**AssistantQueueListing**](AssistantQueueListing.html)
+
+
+
+## [**Assistant**](Assistant.html) post_assistants(body)
+
+
+
+Create an Assistant.
+
+Wraps POST /api/v2/assistants
+
+Requires ALL permissions:
+
+* assistants:assistant:add
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.AgentAssistantsApi()
+body = PureCloudPlatformClientV2.Assistant() # Assistant |
+
+try:
+ # Create an Assistant.
+ api_response = api_instance.post_assistants(body)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling AgentAssistantsApi->post_assistants: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | [**Assistant**](Assistant.html)| | |
+{: class="table table-striped"}
+
+### Return type
+
+[**Assistant**](Assistant.html)
+
+
+
+## [**AssistantQueue**](AssistantQueue.html) put_assistant_queue(assistant_id, queue_id, body)
+
+
+
+Create a queue assistant association.
+
+Wraps PUT /api/v2/assistants/{assistantId}/queues/{queueId}
+
+Requires ALL permissions:
+
+* assistants:queue:edit
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.AgentAssistantsApi()
+assistant_id = 'assistant_id_example' # str | Assistant ID
+queue_id = 'queue_id_example' # str | Queue ID
+body = PureCloudPlatformClientV2.AssistantQueue() # AssistantQueue |
+
+try:
+ # Create a queue assistant association.
+ api_response = api_instance.put_assistant_queue(assistant_id, queue_id, body)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling AgentAssistantsApi->put_assistant_queue: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **assistant_id** | **str**| Assistant ID | |
+| **queue_id** | **str**| Queue ID | |
+| **body** | [**AssistantQueue**](AssistantQueue.html)| | |
+{: class="table table-striped"}
+
+### Return type
+
+[**AssistantQueue**](AssistantQueue.html)
+
diff --git a/build/docs/AgentCopilotApi.md b/build/docs/AgentCopilotApi.md
new file mode 100644
index 000000000..d68ab16e4
--- /dev/null
+++ b/build/docs/AgentCopilotApi.md
@@ -0,0 +1,114 @@
+---
+title: AgentCopilotApi
+---
+
+## PureCloudPlatformClientV2.AgentCopilotApi
+
+All URIs are relative to *https://api.mypurecloud.com*
+
+|Method | Description|
+|------------- | -------------|
+|[**get_assistant_copilot**](AgentCopilotApi.html#get_assistant_copilot) | Get copilot configuration of an assistant.|
+|[**put_assistant_copilot**](AgentCopilotApi.html#put_assistant_copilot) | Update agent copilot configuration|
+{: class="table table-striped"}
+
+
+
+## [**Copilot**](Copilot.html) get_assistant_copilot(assistant_id)
+
+
+
+Get copilot configuration of an assistant.
+
+Wraps GET /api/v2/assistants/{assistantId}/copilot
+
+Requires ALL permissions:
+
+* assistants:copilot:view
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.AgentCopilotApi()
+assistant_id = 'assistant_id_example' # str | Assistant ID
+
+try:
+ # Get copilot configuration of an assistant.
+ api_response = api_instance.get_assistant_copilot(assistant_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling AgentCopilotApi->get_assistant_copilot: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **assistant_id** | **str**| Assistant ID | |
+{: class="table table-striped"}
+
+### Return type
+
+[**Copilot**](Copilot.html)
+
+
+
+## [**Copilot**](Copilot.html) put_assistant_copilot(assistant_id, body)
+
+
+
+Update agent copilot configuration
+
+Wraps PUT /api/v2/assistants/{assistantId}/copilot
+
+Requires ALL permissions:
+
+* assistants:copilot:edit
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.AgentCopilotApi()
+assistant_id = 'assistant_id_example' # str | Assistant ID
+body = PureCloudPlatformClientV2.Copilot() # Copilot |
+
+try:
+ # Update agent copilot configuration
+ api_response = api_instance.put_assistant_copilot(assistant_id, body)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling AgentCopilotApi->put_assistant_copilot: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **assistant_id** | **str**| Assistant ID | |
+| **body** | [**Copilot**](Copilot.html)| | |
+{: class="table table-striped"}
+
+### Return type
+
+[**Copilot**](Copilot.html)
+
diff --git a/build/docs/AlertListing.md b/build/docs/AlertListing.md
index 432cc7ea2..aeca3d5cc 100644
--- a/build/docs/AlertListing.md
+++ b/build/docs/AlertListing.md
@@ -11,8 +11,8 @@ title: AlertListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/AnalyticsApi.md b/build/docs/AnalyticsApi.md
index fb16a76d5..437f30c80 100644
--- a/build/docs/AnalyticsApi.md
+++ b/build/docs/AnalyticsApi.md
@@ -1875,7 +1875,7 @@ This endpoint does not need any parameters.
-## [**DashboardConfigurationListing**](DashboardConfigurationListing.html) get_analytics_reporting_settings_dashboards_query(dashboard_type, dashboard_access_filter, sort_by=sort_by, page_number=page_number, page_size=page_size)
+## [**DashboardConfigurationListing**](DashboardConfigurationListing.html) get_analytics_reporting_settings_dashboards_query(dashboard_type, dashboard_access_filter, name=name, sort_by=sort_by, page_number=page_number, page_size=page_size)
@@ -1902,13 +1902,14 @@ PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
api_instance = PureCloudPlatformClientV2.AnalyticsApi()
dashboard_type = 'dashboard_type_example' # str | List dashboard of given type
dashboard_access_filter = 'dashboard_access_filter_example' # str | Filter dashboard based on the owner of dashboard
+name = 'name_example' # str | name of the dashboard (optional)
sort_by = ''desc'' # str | (optional) (default to 'desc')
page_number = 1 # int | (optional) (default to 1)
page_size = 9 # int | (optional) (default to 9)
try:
# Get list of dashboard configurations
- api_response = api_instance.get_analytics_reporting_settings_dashboards_query(dashboard_type, dashboard_access_filter, sort_by=sort_by, page_number=page_number, page_size=page_size)
+ api_response = api_instance.get_analytics_reporting_settings_dashboards_query(dashboard_type, dashboard_access_filter, name=name, sort_by=sort_by, page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->get_analytics_reporting_settings_dashboards_query: %s\n" % e)
@@ -1921,6 +1922,7 @@ except ApiException as e:
|------------- | ------------- | ------------- | -------------|
| **dashboard_type** | **str**| List dashboard of given type |
**Values**: All, Public, Private, Shared, Favorites |
| **dashboard_access_filter** | **str**| Filter dashboard based on the owner of dashboard |
**Values**: OwnedByMe, OwnedByAnyone, NotOwnedByMe |
+| **name** | **str**| name of the dashboard | [optional] |
| **sort_by** | **str**| | [optional] [default to 'desc'] |
| **page_number** | **int**| | [optional] [default to 1] |
| **page_size** | **int**| | [optional] [default to 9] |
@@ -2868,8 +2870,6 @@ except ApiException as e:
Query for agent copilot aggregates
-post_analytics_agentcopilots_aggregates_query is a preview method and is subject to both breaking and non-breaking changes at any time without notice
-
Wraps POST /api/v2/analytics/agentcopilots/aggregates/query
Requires ANY permissions:
diff --git a/build/docs/AnswerGenerationConfig.md b/build/docs/AnswerGenerationConfig.md
new file mode 100644
index 000000000..cb80b9012
--- /dev/null
+++ b/build/docs/AnswerGenerationConfig.md
@@ -0,0 +1,13 @@
+---
+title: AnswerGenerationConfig
+---
+## AnswerGenerationConfig
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **enabled** | **bool** | Answer generation is enabled. | |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/AssignedLearningModuleDomainEntityListing.md b/build/docs/AssignedLearningModuleDomainEntityListing.md
index 2b062b62e..a2afe1473 100644
--- a/build/docs/AssignedLearningModuleDomainEntityListing.md
+++ b/build/docs/AssignedLearningModuleDomainEntityListing.md
@@ -11,8 +11,8 @@ title: AssignedLearningModuleDomainEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/Assistant.md b/build/docs/Assistant.md
new file mode 100644
index 000000000..ba4dc0f1d
--- /dev/null
+++ b/build/docs/Assistant.md
@@ -0,0 +1,24 @@
+---
+title: Assistant
+---
+## Assistant
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **str** | The globally unique identifier for the object. | [optional] |
+| **name** | **str** | The name of the assistant that will assist the agent. | |
+| **date_created** | **datetime** | Date when the assistant was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z | [optional] |
+| **date_modified** | **datetime** | 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 | [optional] |
+| **created_by** | [**UserReference**](UserReference.html) | The user who created the assistant. | [optional] |
+| **modified_by** | [**UserReference**](UserReference.html) | The user who last modified the assistant. | [optional] |
+| **google_dialogflow_config** | [**GoogleDialogflowConfig**](GoogleDialogflowConfig.html) | Configuration of Dialogflow used to assist the agent with transcriptions and knowledge suggestions. | [optional] |
+| **transcription_config** | [**TranscriptionConfig**](TranscriptionConfig.html) | Configuration for speech transcription used to assist the agent. | |
+| **knowledge_suggestion_config** | [**KnowledgeSuggestionConfig**](KnowledgeSuggestionConfig.html) | Configuration that defines how to produce knowledge suggestions. | |
+| **state** | **str** | State of the assistant. | [optional] |
+| **copilot** | [**Copilot**](Copilot.html) | Agent copilot configuration. | [optional] |
+| **self_uri** | **str** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/AssistantListing.md b/build/docs/AssistantListing.md
new file mode 100644
index 000000000..4e6a5d221
--- /dev/null
+++ b/build/docs/AssistantListing.md
@@ -0,0 +1,16 @@
+---
+title: AssistantListing
+---
+## AssistantListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**list[Assistant]**](Assistant.html) | | [optional] |
+| **next_uri** | **str** | | [optional] |
+| **self_uri** | **str** | | [optional] |
+| **previous_uri** | **str** | | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/AssistantQueue.md b/build/docs/AssistantQueue.md
new file mode 100644
index 000000000..5bcd1c97a
--- /dev/null
+++ b/build/docs/AssistantQueue.md
@@ -0,0 +1,18 @@
+---
+title: AssistantQueue
+---
+## AssistantQueue
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **str** | The globally unique identifier for the queue. | |
+| **media_types** | **list[str]** | List of media Types in which the assistant is activated for this queue. | |
+| **assistant** | [**Assistant**](Assistant.html) | Assistant to which the queue is assigned. | [optional] |
+| **date_created** | **datetime** | 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 | [optional] |
+| **date_modified** | **datetime** | 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 | [optional] |
+| **self_uri** | **str** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/AssistantQueueListing.md b/build/docs/AssistantQueueListing.md
new file mode 100644
index 000000000..75addd494
--- /dev/null
+++ b/build/docs/AssistantQueueListing.md
@@ -0,0 +1,16 @@
+---
+title: AssistantQueueListing
+---
+## AssistantQueueListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**list[AssistantQueue]**](AssistantQueue.html) | | [optional] |
+| **next_uri** | **str** | | [optional] |
+| **self_uri** | **str** | | [optional] |
+| **previous_uri** | **str** | | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/AttemptLimitsEntityListing.md b/build/docs/AttemptLimitsEntityListing.md
index fbb1fb99c..aeba21181 100644
--- a/build/docs/AttemptLimitsEntityListing.md
+++ b/build/docs/AttemptLimitsEntityListing.md
@@ -11,8 +11,8 @@ title: AttemptLimitsEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/AuthzDivisionEntityListing.md b/build/docs/AuthzDivisionEntityListing.md
index 97c13dfc0..ac23c9f8f 100644
--- a/build/docs/AuthzDivisionEntityListing.md
+++ b/build/docs/AuthzDivisionEntityListing.md
@@ -11,8 +11,8 @@ title: AuthzDivisionEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/BotConnectorBotSummaryEntityListing.md b/build/docs/BotConnectorBotSummaryEntityListing.md
index 00adb7249..5ed71746e 100644
--- a/build/docs/BotConnectorBotSummaryEntityListing.md
+++ b/build/docs/BotConnectorBotSummaryEntityListing.md
@@ -11,8 +11,8 @@ title: BotConnectorBotSummaryEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/BotConnectorBotVersionSummaryEntityListing.md b/build/docs/BotConnectorBotVersionSummaryEntityListing.md
index eee8263db..ef24dd28c 100644
--- a/build/docs/BotConnectorBotVersionSummaryEntityListing.md
+++ b/build/docs/BotConnectorBotVersionSummaryEntityListing.md
@@ -11,8 +11,8 @@ title: BotConnectorBotVersionSummaryEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/BuActivitySettingsRequest.md b/build/docs/BuActivitySettingsRequest.md
new file mode 100644
index 000000000..09f8e5f75
--- /dev/null
+++ b/build/docs/BuActivitySettingsRequest.md
@@ -0,0 +1,13 @@
+---
+title: BuActivitySettingsRequest
+---
+## BuActivitySettingsRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **default_activity_code_id** | **str** | Default Activity Code ID settings | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/BuActivitySettingsResponse.md b/build/docs/BuActivitySettingsResponse.md
new file mode 100644
index 000000000..b495adcf0
--- /dev/null
+++ b/build/docs/BuActivitySettingsResponse.md
@@ -0,0 +1,13 @@
+---
+title: BuActivitySettingsResponse
+---
+## BuActivitySettingsResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **default_activity_code** | [**ActivityCodeReference**](ActivityCodeReference.html) | Default Activity Code settings | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/BuNotificationSettingsRequest.md b/build/docs/BuNotificationSettingsRequest.md
new file mode 100644
index 000000000..bf44be76b
--- /dev/null
+++ b/build/docs/BuNotificationSettingsRequest.md
@@ -0,0 +1,13 @@
+---
+title: BuNotificationSettingsRequest
+---
+## BuNotificationSettingsRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **scheduling** | [**BuScheduleNotificationsSettingsRequest**](BuScheduleNotificationsSettingsRequest.html) | Schedule notification settings | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/BuNotificationSettingsResponse.md b/build/docs/BuNotificationSettingsResponse.md
new file mode 100644
index 000000000..8d59b7ddb
--- /dev/null
+++ b/build/docs/BuNotificationSettingsResponse.md
@@ -0,0 +1,13 @@
+---
+title: BuNotificationSettingsResponse
+---
+## BuNotificationSettingsResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **scheduling** | [**BuScheduleNotificationsSettingsResponse**](BuScheduleNotificationsSettingsResponse.html) | Schedule notification settings | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/BuScheduleNotificationsCategorySettings.md b/build/docs/BuScheduleNotificationsCategorySettings.md
new file mode 100644
index 000000000..7beba0f68
--- /dev/null
+++ b/build/docs/BuScheduleNotificationsCategorySettings.md
@@ -0,0 +1,15 @@
+---
+title: BuScheduleNotificationsCategorySettings
+---
+## BuScheduleNotificationsCategorySettings
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **activity_category** | **str** | The activity category | |
+| **early_reminder_enabled** | **bool** | Indicates if agents should receive early schedule reminder notifications. | |
+| **on_time_reminder_enabled** | **bool** | Indicates if agents should receive out of adherence notifications. | |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/BuScheduleNotificationsSettingsRequest.md b/build/docs/BuScheduleNotificationsSettingsRequest.md
new file mode 100644
index 000000000..06a5f8458
--- /dev/null
+++ b/build/docs/BuScheduleNotificationsSettingsRequest.md
@@ -0,0 +1,14 @@
+---
+title: BuScheduleNotificationsSettingsRequest
+---
+## BuScheduleNotificationsSettingsRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **early_reminder_minutes** | **int** | The number of minutes prior to the scheduled event to display an early reminder notification | [optional] |
+| **activity_category_settings** | [**list[BuScheduleNotificationsCategorySettings]**](BuScheduleNotificationsCategorySettings.html) | List of activity category notification settings | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/BuScheduleNotificationsSettingsResponse.md b/build/docs/BuScheduleNotificationsSettingsResponse.md
new file mode 100644
index 000000000..b20edd8fa
--- /dev/null
+++ b/build/docs/BuScheduleNotificationsSettingsResponse.md
@@ -0,0 +1,14 @@
+---
+title: BuScheduleNotificationsSettingsResponse
+---
+## BuScheduleNotificationsSettingsResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **early_reminder_minutes** | **int** | The number of minutes prior to the scheduled event to display an early reminder notification | |
+| **activity_category_settings** | [**list[BuScheduleNotificationsCategorySettings]**](BuScheduleNotificationsCategorySettings.html) | List of activity category notification settings | |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/CachedMediaItemEntityListing.md b/build/docs/CachedMediaItemEntityListing.md
index ffae2de34..81f51c4cd 100644
--- a/build/docs/CachedMediaItemEntityListing.md
+++ b/build/docs/CachedMediaItemEntityListing.md
@@ -11,8 +11,8 @@ title: CachedMediaItemEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CalibrationEntityListing.md b/build/docs/CalibrationEntityListing.md
index 1269c9dcc..ada402780 100644
--- a/build/docs/CalibrationEntityListing.md
+++ b/build/docs/CalibrationEntityListing.md
@@ -11,8 +11,8 @@ title: CalibrationEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CallConversationEntityListing.md b/build/docs/CallConversationEntityListing.md
index ee1627c20..a5c940458 100644
--- a/build/docs/CallConversationEntityListing.md
+++ b/build/docs/CallConversationEntityListing.md
@@ -11,8 +11,8 @@ title: CallConversationEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CallHistoryConversationEntityListing.md b/build/docs/CallHistoryConversationEntityListing.md
index 5a6be7dc4..5926d615f 100644
--- a/build/docs/CallHistoryConversationEntityListing.md
+++ b/build/docs/CallHistoryConversationEntityListing.md
@@ -11,8 +11,8 @@ title: CallHistoryConversationEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CallableTimeSetEntityListing.md b/build/docs/CallableTimeSetEntityListing.md
index d865b4f82..f548e0f2c 100644
--- a/build/docs/CallableTimeSetEntityListing.md
+++ b/build/docs/CallableTimeSetEntityListing.md
@@ -11,8 +11,8 @@ title: CallableTimeSetEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CallbackConversationEntityListing.md b/build/docs/CallbackConversationEntityListing.md
index 6887b87e9..503d41454 100644
--- a/build/docs/CallbackConversationEntityListing.md
+++ b/build/docs/CallbackConversationEntityListing.md
@@ -11,8 +11,8 @@ title: CallbackConversationEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CampaignDivisionViewListing.md b/build/docs/CampaignDivisionViewListing.md
index 9d6382629..d962fec31 100644
--- a/build/docs/CampaignDivisionViewListing.md
+++ b/build/docs/CampaignDivisionViewListing.md
@@ -11,8 +11,8 @@ title: CampaignDivisionViewListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CampaignEntityListing.md b/build/docs/CampaignEntityListing.md
index 4d0a0dd97..92b0beaa1 100644
--- a/build/docs/CampaignEntityListing.md
+++ b/build/docs/CampaignEntityListing.md
@@ -11,8 +11,8 @@ title: CampaignEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CampaignRuleConditionGroup.md b/build/docs/CampaignRuleConditionGroup.md
new file mode 100644
index 000000000..7e18906e0
--- /dev/null
+++ b/build/docs/CampaignRuleConditionGroup.md
@@ -0,0 +1,14 @@
+---
+title: CampaignRuleConditionGroup
+---
+## CampaignRuleConditionGroup
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **match_any_conditions** | **bool** | Whether or not this condition group should be evaluated as true if any of sub conditions is matched | |
+| **conditions** | [**list[CampaignRuleCondition]**](CampaignRuleCondition.html) | The parameters for the CampaignRuleCondition. | |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/CampaignRuleEntityListing.md b/build/docs/CampaignRuleEntityListing.md
index 44e5b46f9..72acbcee7 100644
--- a/build/docs/CampaignRuleEntityListing.md
+++ b/build/docs/CampaignRuleEntityListing.md
@@ -11,8 +11,8 @@ title: CampaignRuleEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CampaignSequenceEntityListing.md b/build/docs/CampaignSequenceEntityListing.md
index b1c37eca4..3735e0152 100644
--- a/build/docs/CampaignSequenceEntityListing.md
+++ b/build/docs/CampaignSequenceEntityListing.md
@@ -11,8 +11,8 @@ title: CampaignSequenceEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CategoriesEntityListing.md b/build/docs/CategoriesEntityListing.md
index 56b52ebf9..ab48afb7b 100644
--- a/build/docs/CategoriesEntityListing.md
+++ b/build/docs/CategoriesEntityListing.md
@@ -11,8 +11,8 @@ title: CategoriesEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CertificateAuthorityEntityListing.md b/build/docs/CertificateAuthorityEntityListing.md
index a778adeef..661a4634b 100644
--- a/build/docs/CertificateAuthorityEntityListing.md
+++ b/build/docs/CertificateAuthorityEntityListing.md
@@ -11,8 +11,8 @@ title: CertificateAuthorityEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ChatConversationEntityListing.md b/build/docs/ChatConversationEntityListing.md
index 55407496f..95e760d75 100644
--- a/build/docs/ChatConversationEntityListing.md
+++ b/build/docs/ChatConversationEntityListing.md
@@ -11,8 +11,8 @@ title: ChatConversationEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ClientAppEntityListing.md b/build/docs/ClientAppEntityListing.md
index d5d057e71..682539cb8 100644
--- a/build/docs/ClientAppEntityListing.md
+++ b/build/docs/ClientAppEntityListing.md
@@ -11,8 +11,8 @@ title: ClientAppEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CoachingAnnotationList.md b/build/docs/CoachingAnnotationList.md
index 8b43d50b0..2be09d235 100644
--- a/build/docs/CoachingAnnotationList.md
+++ b/build/docs/CoachingAnnotationList.md
@@ -11,8 +11,8 @@ title: CoachingAnnotationList
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CoachingAppointmentResponseList.md b/build/docs/CoachingAppointmentResponseList.md
index 9e35d282a..3f375e9ed 100644
--- a/build/docs/CoachingAppointmentResponseList.md
+++ b/build/docs/CoachingAppointmentResponseList.md
@@ -11,8 +11,8 @@ title: CoachingAppointmentResponseList
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CoachingNotificationList.md b/build/docs/CoachingNotificationList.md
index 3b67ab11f..718f0e316 100644
--- a/build/docs/CoachingNotificationList.md
+++ b/build/docs/CoachingNotificationList.md
@@ -11,8 +11,8 @@ title: CoachingNotificationList
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CobrowseConversationEntityListing.md b/build/docs/CobrowseConversationEntityListing.md
index d24f8163b..b04be8d28 100644
--- a/build/docs/CobrowseConversationEntityListing.md
+++ b/build/docs/CobrowseConversationEntityListing.md
@@ -11,8 +11,8 @@ title: CobrowseConversationEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CommandStatusEntityListing.md b/build/docs/CommandStatusEntityListing.md
index 1afad1ec2..1becf5021 100644
--- a/build/docs/CommandStatusEntityListing.md
+++ b/build/docs/CommandStatusEntityListing.md
@@ -11,8 +11,8 @@ title: CommandStatusEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CommonCampaignDivisionViewEntityListing.md b/build/docs/CommonCampaignDivisionViewEntityListing.md
index 88085e3ed..2602df000 100644
--- a/build/docs/CommonCampaignDivisionViewEntityListing.md
+++ b/build/docs/CommonCampaignDivisionViewEntityListing.md
@@ -11,8 +11,8 @@ title: CommonCampaignDivisionViewEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CommonCampaignEntityListing.md b/build/docs/CommonCampaignEntityListing.md
index 8ddde538d..c36901e8e 100644
--- a/build/docs/CommonCampaignEntityListing.md
+++ b/build/docs/CommonCampaignEntityListing.md
@@ -11,8 +11,8 @@ title: CommonCampaignEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CommonRuleContainer.md b/build/docs/CommonRuleContainer.md
index 17c4a4945..179364a13 100644
--- a/build/docs/CommonRuleContainer.md
+++ b/build/docs/CommonRuleContainer.md
@@ -11,8 +11,8 @@ title: CommonRuleContainer
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ConsumedResourcesEntityListing.md b/build/docs/ConsumedResourcesEntityListing.md
index a898d266b..c34d04fc5 100644
--- a/build/docs/ConsumedResourcesEntityListing.md
+++ b/build/docs/ConsumedResourcesEntityListing.md
@@ -11,8 +11,8 @@ title: ConsumedResourcesEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ConsumingResourcesEntityListing.md b/build/docs/ConsumingResourcesEntityListing.md
index 9588c4aa1..f95ecda54 100644
--- a/build/docs/ConsumingResourcesEntityListing.md
+++ b/build/docs/ConsumingResourcesEntityListing.md
@@ -11,8 +11,8 @@ title: ConsumingResourcesEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ContactListDivisionViewListing.md b/build/docs/ContactListDivisionViewListing.md
index 51cf02a12..e8d08fbe2 100644
--- a/build/docs/ContactListDivisionViewListing.md
+++ b/build/docs/ContactListDivisionViewListing.md
@@ -11,8 +11,8 @@ title: ContactListDivisionViewListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ContactListEntityListing.md b/build/docs/ContactListEntityListing.md
index 0b91673ff..73eaebd5c 100644
--- a/build/docs/ContactListEntityListing.md
+++ b/build/docs/ContactListEntityListing.md
@@ -11,8 +11,8 @@ title: ContactListEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ContactListFilterEntityListing.md b/build/docs/ContactListFilterEntityListing.md
index f9894d2fe..c7bb25f98 100644
--- a/build/docs/ContactListFilterEntityListing.md
+++ b/build/docs/ContactListFilterEntityListing.md
@@ -11,8 +11,8 @@ title: ContactListFilterEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ContactListTemplateEntityListing.md b/build/docs/ContactListTemplateEntityListing.md
index a219ef9ca..af92af8d3 100644
--- a/build/docs/ContactListTemplateEntityListing.md
+++ b/build/docs/ContactListTemplateEntityListing.md
@@ -11,8 +11,8 @@ title: ContactListTemplateEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ContactListingResponse.md b/build/docs/ContactListingResponse.md
index 7df17f3e0..4152cb2d1 100644
--- a/build/docs/ContactListingResponse.md
+++ b/build/docs/ContactListingResponse.md
@@ -12,8 +12,8 @@ title: ContactListingResponse
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **contacts_count** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ConversationAppSettings.md b/build/docs/ConversationAppSettings.md
index 4efc2987c..89ac2e8d0 100644
--- a/build/docs/ConversationAppSettings.md
+++ b/build/docs/ConversationAppSettings.md
@@ -15,6 +15,7 @@ title: ConversationAppSettings
| **conversation_disconnect** | [**ConversationDisconnectSettings**](ConversationDisconnectSettings.html) | The conversation disconnect settings for the messenger app | [optional] |
| **conversation_clear** | [**ConversationClearSettings**](ConversationClearSettings.html) | The conversation clear settings for the messenger app | [optional] |
| **humanize** | [**Humanize**](Humanize.html) | The humanize conversations settings for the messenger app | [optional] |
+| **notifications** | [**NotificationsSettings**](NotificationsSettings.html) | The notification settings for messenger apps | [optional] |
{: class="table table-striped"}
diff --git a/build/docs/ConversationCategoriesEntityListing.md b/build/docs/ConversationCategoriesEntityListing.md
index d13c43bc2..3268b1d21 100644
--- a/build/docs/ConversationCategoriesEntityListing.md
+++ b/build/docs/ConversationCategoriesEntityListing.md
@@ -11,8 +11,8 @@ title: ConversationCategoriesEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ConversationEntityListing.md b/build/docs/ConversationEntityListing.md
index 2ff68e5af..205d0a101 100644
--- a/build/docs/ConversationEntityListing.md
+++ b/build/docs/ConversationEntityListing.md
@@ -11,8 +11,8 @@ title: ConversationEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ConversationProfile.md b/build/docs/ConversationProfile.md
new file mode 100644
index 000000000..787a1232f
--- /dev/null
+++ b/build/docs/ConversationProfile.md
@@ -0,0 +1,14 @@
+---
+title: ConversationProfile
+---
+## ConversationProfile
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **language_code** | **str** | The language code supported by the conversation profile belonging to a particular project for Dialogflow. | |
+| **name** | **str** | The name of the conversation profile belonging to a particular project for Dialogflow | |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/Copilot.md b/build/docs/Copilot.md
new file mode 100644
index 000000000..13dbe5f95
--- /dev/null
+++ b/build/docs/Copilot.md
@@ -0,0 +1,23 @@
+---
+title: Copilot
+---
+## Copilot
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **enabled** | **bool** | Copilot is enabled. | [optional] |
+| **live_on_queue** | **bool** | Copilot is live on selected queue. | |
+| **default_language** | **str** | Copilot default language, e.g. [en-US, es-US, es-ES]. Once set, it can not be modified. | |
+| **knowledge_answer_config** | [**KnowledgeAnswerConfig**](KnowledgeAnswerConfig.html) | Knowledge answer configuration. | [optional] |
+| **summary_generation_config** | [**SummaryGenerationConfig**](SummaryGenerationConfig.html) | Copilot generated summary configuration. | [optional] |
+| **wrapup_code_prediction_config** | [**WrapupCodePredictionConfig**](WrapupCodePredictionConfig.html) | Copilot generated wrapup code prediction configuration. | [optional] |
+| **answer_generation_config** | [**AnswerGenerationConfig**](AnswerGenerationConfig.html) | Answer generation configuration. | [optional] |
+| **nlu_engine_type** | **str** | Language understanding engine type. | [optional] |
+| **nlu_config** | [**NluConfig**](NluConfig.html) | NLU configuration. | [optional] |
+| **rule_engine_config** | [**RuleEngineConfig**](RuleEngineConfig.html) | Rule engine configuration. | [optional] |
+| **self_uri** | **str** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/CopilotAction.md b/build/docs/CopilotAction.md
new file mode 100644
index 000000000..9b8deb98b
--- /dev/null
+++ b/build/docs/CopilotAction.md
@@ -0,0 +1,14 @@
+---
+title: CopilotAction
+---
+## CopilotAction
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **action_type** | **str** | Type of action. | |
+| **attributes** | **dict(str, str)** | Action specific attributes, if any. Maximum 100 of string key-value pair allowed. | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/CopilotCondition.md b/build/docs/CopilotCondition.md
new file mode 100644
index 000000000..eb9ffbce1
--- /dev/null
+++ b/build/docs/CopilotCondition.md
@@ -0,0 +1,14 @@
+---
+title: CopilotCondition
+---
+## CopilotCondition
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **condition_type** | **str** | Type of condition. | |
+| **condition_values** | **list[str]** | Condition values. | |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/CopilotFallbackAction.md b/build/docs/CopilotFallbackAction.md
new file mode 100644
index 000000000..70eff5188
--- /dev/null
+++ b/build/docs/CopilotFallbackAction.md
@@ -0,0 +1,14 @@
+---
+title: CopilotFallbackAction
+---
+## CopilotFallbackAction
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **action_type** | **str** | Type of action. | |
+| **attributes** | **dict(str, str)** | Action specific attributes, if any. Maximum 100 of string key-value pair allowed. | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/CopilotNluDomain.md b/build/docs/CopilotNluDomain.md
new file mode 100644
index 000000000..9b3e377cf
--- /dev/null
+++ b/build/docs/CopilotNluDomain.md
@@ -0,0 +1,16 @@
+---
+title: CopilotNluDomain
+---
+## CopilotNluDomain
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **str** | Id of the NLU domain. | |
+| **use_latest_version** | **bool** | Use the latest version of the NLU domain. If false, version is required. | |
+| **version** | [**CopilotNluDomainVersion**](CopilotNluDomainVersion.html) | NLU domain version. | [optional] |
+| **self_uri** | **str** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/CopilotNluDomainVersion.md b/build/docs/CopilotNluDomainVersion.md
new file mode 100644
index 000000000..44b72c516
--- /dev/null
+++ b/build/docs/CopilotNluDomainVersion.md
@@ -0,0 +1,14 @@
+---
+title: CopilotNluDomainVersion
+---
+## CopilotNluDomainVersion
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **str** | Id of the NLU v3 domain version. | |
+| **self_uri** | **str** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/CopilotRule.md b/build/docs/CopilotRule.md
new file mode 100644
index 000000000..8a8682c51
--- /dev/null
+++ b/build/docs/CopilotRule.md
@@ -0,0 +1,14 @@
+---
+title: CopilotRule
+---
+## CopilotRule
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **conditions** | [**list[CopilotCondition]**](CopilotCondition.html) | List of conditions to execute actions, must have at least 1 element and maximum 100 elements. Operator in case of multiple conditions: 'OR'. | |
+| **actions** | [**list[CopilotAction]**](CopilotAction.html) | List of actions to execute, must have at least 1 element and maximum 100 elements. | |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/CredentialInfoListing.md b/build/docs/CredentialInfoListing.md
index 0576e87db..93b1beea3 100644
--- a/build/docs/CredentialInfoListing.md
+++ b/build/docs/CredentialInfoListing.md
@@ -11,8 +11,8 @@ title: CredentialInfoListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CredentialTypeListing.md b/build/docs/CredentialTypeListing.md
index 73d5aa0f5..ad251b519 100644
--- a/build/docs/CredentialTypeListing.md
+++ b/build/docs/CredentialTypeListing.md
@@ -11,8 +11,8 @@ title: CredentialTypeListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/CursorExternalSourceListing.md b/build/docs/CursorExternalSourceListing.md
new file mode 100644
index 000000000..083f4984d
--- /dev/null
+++ b/build/docs/CursorExternalSourceListing.md
@@ -0,0 +1,17 @@
+---
+title: CursorExternalSourceListing
+---
+## CursorExternalSourceListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**list[ExternalSource]**](ExternalSource.html) | | [optional] |
+| **next_uri** | **str** | | [optional] |
+| **self_uri** | **str** | | [optional] |
+| **previous_uri** | **str** | | [optional] |
+| **cursors** | [**Cursors**](Cursors.html) | The cursor that points to the next set of entities being returned. | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/DIDEntityListing.md b/build/docs/DIDEntityListing.md
index e86c604d0..237def11b 100644
--- a/build/docs/DIDEntityListing.md
+++ b/build/docs/DIDEntityListing.md
@@ -12,8 +12,8 @@ title: DIDEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DIDNumberEntityListing.md b/build/docs/DIDNumberEntityListing.md
index 505de14f2..5ef9a814b 100644
--- a/build/docs/DIDNumberEntityListing.md
+++ b/build/docs/DIDNumberEntityListing.md
@@ -11,8 +11,8 @@ title: DIDNumberEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DIDPoolEntityListing.md b/build/docs/DIDPoolEntityListing.md
index c8c014161..9b7f63315 100644
--- a/build/docs/DIDPoolEntityListing.md
+++ b/build/docs/DIDPoolEntityListing.md
@@ -12,8 +12,8 @@ title: DIDPoolEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DashboardConfigurationListing.md b/build/docs/DashboardConfigurationListing.md
index afd93aa7b..a3c1d50bd 100644
--- a/build/docs/DashboardConfigurationListing.md
+++ b/build/docs/DashboardConfigurationListing.md
@@ -11,8 +11,8 @@ title: DashboardConfigurationListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DashboardUserListing.md b/build/docs/DashboardUserListing.md
index 5ab2a0c2e..2119b00ba 100644
--- a/build/docs/DashboardUserListing.md
+++ b/build/docs/DashboardUserListing.md
@@ -11,8 +11,8 @@ title: DashboardUserListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DataTableRowEntityListing.md b/build/docs/DataTableRowEntityListing.md
index 6db2a72d3..6c1f23d7d 100644
--- a/build/docs/DataTableRowEntityListing.md
+++ b/build/docs/DataTableRowEntityListing.md
@@ -11,8 +11,8 @@ title: DataTableRowEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DataTablesDomainEntityListing.md b/build/docs/DataTablesDomainEntityListing.md
index 2bcd1ee2b..2c72de44e 100644
--- a/build/docs/DataTablesDomainEntityListing.md
+++ b/build/docs/DataTablesDomainEntityListing.md
@@ -11,8 +11,8 @@ title: DataTablesDomainEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DependencyObjectEntityListing.md b/build/docs/DependencyObjectEntityListing.md
index b4656d0da..2bec57781 100644
--- a/build/docs/DependencyObjectEntityListing.md
+++ b/build/docs/DependencyObjectEntityListing.md
@@ -11,8 +11,8 @@ title: DependencyObjectEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DependencyTypeEntityListing.md b/build/docs/DependencyTypeEntityListing.md
index 8539952d4..97d0f4cb1 100644
--- a/build/docs/DependencyTypeEntityListing.md
+++ b/build/docs/DependencyTypeEntityListing.md
@@ -11,8 +11,8 @@ title: DependencyTypeEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DevelopmentActivityListing.md b/build/docs/DevelopmentActivityListing.md
index ce0a4bfe3..675cfe65a 100644
--- a/build/docs/DevelopmentActivityListing.md
+++ b/build/docs/DevelopmentActivityListing.md
@@ -11,8 +11,8 @@ title: DevelopmentActivityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DialerEventEntityListing.md b/build/docs/DialerEventEntityListing.md
index 777009a37..faf9ff689 100644
--- a/build/docs/DialerEventEntityListing.md
+++ b/build/docs/DialerEventEntityListing.md
@@ -11,8 +11,8 @@ title: DialerEventEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DialogflowAgentSummaryEntityListing.md b/build/docs/DialogflowAgentSummaryEntityListing.md
index d123846ea..7d63572b7 100644
--- a/build/docs/DialogflowAgentSummaryEntityListing.md
+++ b/build/docs/DialogflowAgentSummaryEntityListing.md
@@ -11,8 +11,8 @@ title: DialogflowAgentSummaryEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DialogflowCXAgentSummaryEntityListing.md b/build/docs/DialogflowCXAgentSummaryEntityListing.md
index d86fdade2..55ceb3940 100644
--- a/build/docs/DialogflowCXAgentSummaryEntityListing.md
+++ b/build/docs/DialogflowCXAgentSummaryEntityListing.md
@@ -11,8 +11,8 @@ title: DialogflowCXAgentSummaryEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DigitalRuleSetEntityListing.md b/build/docs/DigitalRuleSetEntityListing.md
index 6e60db13f..d5a4fb4ac 100644
--- a/build/docs/DigitalRuleSetEntityListing.md
+++ b/build/docs/DigitalRuleSetEntityListing.md
@@ -11,8 +11,8 @@ title: DigitalRuleSetEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DirectoryUserDevicesListing.md b/build/docs/DirectoryUserDevicesListing.md
index a271bdc8d..9482740bb 100644
--- a/build/docs/DirectoryUserDevicesListing.md
+++ b/build/docs/DirectoryUserDevicesListing.md
@@ -11,8 +11,8 @@ title: DirectoryUserDevicesListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DivsPermittedEntityListing.md b/build/docs/DivsPermittedEntityListing.md
index 84e1e5cd6..b8168712e 100644
--- a/build/docs/DivsPermittedEntityListing.md
+++ b/build/docs/DivsPermittedEntityListing.md
@@ -12,8 +12,8 @@ title: DivsPermittedEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **all_divs_permitted** | **bool** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DncListDivisionViewListing.md b/build/docs/DncListDivisionViewListing.md
index 1d8d98b87..757bdd7c8 100644
--- a/build/docs/DncListDivisionViewListing.md
+++ b/build/docs/DncListDivisionViewListing.md
@@ -11,8 +11,8 @@ title: DncListDivisionViewListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DncListEntityListing.md b/build/docs/DncListEntityListing.md
index ca3a5021e..f4276d52a 100644
--- a/build/docs/DncListEntityListing.md
+++ b/build/docs/DncListEntityListing.md
@@ -11,8 +11,8 @@ title: DncListEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DocumentEntityListing.md b/build/docs/DocumentEntityListing.md
index ed6e2c2c0..745337b8b 100644
--- a/build/docs/DocumentEntityListing.md
+++ b/build/docs/DocumentEntityListing.md
@@ -11,8 +11,8 @@ title: DocumentEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DomainEdgeSoftwareVersionDtoEntityListing.md b/build/docs/DomainEdgeSoftwareVersionDtoEntityListing.md
index 929e2d7e9..a57ede763 100644
--- a/build/docs/DomainEdgeSoftwareVersionDtoEntityListing.md
+++ b/build/docs/DomainEdgeSoftwareVersionDtoEntityListing.md
@@ -11,8 +11,8 @@ title: DomainEdgeSoftwareVersionDtoEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DomainEntityListing.md b/build/docs/DomainEntityListing.md
index 4fb712f81..802162c36 100644
--- a/build/docs/DomainEntityListing.md
+++ b/build/docs/DomainEntityListing.md
@@ -11,8 +11,8 @@ title: DomainEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DomainEntityListingEvaluationForm.md b/build/docs/DomainEntityListingEvaluationForm.md
index 922aa45d5..af6114cd3 100644
--- a/build/docs/DomainEntityListingEvaluationForm.md
+++ b/build/docs/DomainEntityListingEvaluationForm.md
@@ -11,8 +11,8 @@ title: DomainEntityListingEvaluationForm
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DomainEntityListingQueryResult.md b/build/docs/DomainEntityListingQueryResult.md
index 5a6284f22..1cafd6073 100644
--- a/build/docs/DomainEntityListingQueryResult.md
+++ b/build/docs/DomainEntityListingQueryResult.md
@@ -11,8 +11,8 @@ title: DomainEntityListingQueryResult
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/DomainEntityListingSurveyForm.md b/build/docs/DomainEntityListingSurveyForm.md
index 1db24758e..7d0074c8a 100644
--- a/build/docs/DomainEntityListingSurveyForm.md
+++ b/build/docs/DomainEntityListingSurveyForm.md
@@ -11,8 +11,8 @@ title: DomainEntityListingSurveyForm
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/EdgeEntityListing.md b/build/docs/EdgeEntityListing.md
index 1b2dd674e..e55cded1a 100644
--- a/build/docs/EdgeEntityListing.md
+++ b/build/docs/EdgeEntityListing.md
@@ -12,8 +12,8 @@ title: EdgeEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/EdgeGroupEntityListing.md b/build/docs/EdgeGroupEntityListing.md
index 8c31a5544..d37643db1 100644
--- a/build/docs/EdgeGroupEntityListing.md
+++ b/build/docs/EdgeGroupEntityListing.md
@@ -12,8 +12,8 @@ title: EdgeGroupEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/EmailCampaignScheduleEntityListing.md b/build/docs/EmailCampaignScheduleEntityListing.md
index ace5625a1..27acd9682 100644
--- a/build/docs/EmailCampaignScheduleEntityListing.md
+++ b/build/docs/EmailCampaignScheduleEntityListing.md
@@ -11,8 +11,8 @@ title: EmailCampaignScheduleEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/EmailConversationEntityListing.md b/build/docs/EmailConversationEntityListing.md
index fdcbaf354..78e298b64 100644
--- a/build/docs/EmailConversationEntityListing.md
+++ b/build/docs/EmailConversationEntityListing.md
@@ -11,8 +11,8 @@ title: EmailConversationEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/EmailMessagePreviewListing.md b/build/docs/EmailMessagePreviewListing.md
index 1b16078b1..3b6d05d8a 100644
--- a/build/docs/EmailMessagePreviewListing.md
+++ b/build/docs/EmailMessagePreviewListing.md
@@ -11,8 +11,8 @@ title: EmailMessagePreviewListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/EmergencyGroupDivisionViewEntityListing.md b/build/docs/EmergencyGroupDivisionViewEntityListing.md
index 68392fbd5..b5990de43 100644
--- a/build/docs/EmergencyGroupDivisionViewEntityListing.md
+++ b/build/docs/EmergencyGroupDivisionViewEntityListing.md
@@ -12,8 +12,8 @@ title: EmergencyGroupDivisionViewEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/EmergencyGroupListing.md b/build/docs/EmergencyGroupListing.md
index 0225c8bc1..cd58ab2c2 100644
--- a/build/docs/EmergencyGroupListing.md
+++ b/build/docs/EmergencyGroupListing.md
@@ -11,8 +11,8 @@ title: EmergencyGroupListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/EncryptionKeyEntityListing.md b/build/docs/EncryptionKeyEntityListing.md
index 4bbbe2af6..f6974a33c 100644
--- a/build/docs/EncryptionKeyEntityListing.md
+++ b/build/docs/EncryptionKeyEntityListing.md
@@ -11,8 +11,8 @@ title: EncryptionKeyEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/EvaluationEntityListing.md b/build/docs/EvaluationEntityListing.md
index 7c3c1153b..d5e481619 100644
--- a/build/docs/EvaluationEntityListing.md
+++ b/build/docs/EvaluationEntityListing.md
@@ -11,8 +11,8 @@ title: EvaluationEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/EvaluationFormResponseEntityListing.md b/build/docs/EvaluationFormResponseEntityListing.md
index 1c7656b31..2144e749b 100644
--- a/build/docs/EvaluationFormResponseEntityListing.md
+++ b/build/docs/EvaluationFormResponseEntityListing.md
@@ -11,8 +11,8 @@ title: EvaluationFormResponseEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/EvaluatorActivityEntityListing.md b/build/docs/EvaluatorActivityEntityListing.md
index 3cd1554c8..826ddca49 100644
--- a/build/docs/EvaluatorActivityEntityListing.md
+++ b/build/docs/EvaluatorActivityEntityListing.md
@@ -11,8 +11,8 @@ title: EvaluatorActivityEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ExtensionEntityListing.md b/build/docs/ExtensionEntityListing.md
index 2cff02932..d3aad74e1 100644
--- a/build/docs/ExtensionEntityListing.md
+++ b/build/docs/ExtensionEntityListing.md
@@ -12,8 +12,8 @@ title: ExtensionEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ExtensionPoolDivisionViewEntityListing.md b/build/docs/ExtensionPoolDivisionViewEntityListing.md
index 04134c0eb..9d2098eab 100644
--- a/build/docs/ExtensionPoolDivisionViewEntityListing.md
+++ b/build/docs/ExtensionPoolDivisionViewEntityListing.md
@@ -12,8 +12,8 @@ title: ExtensionPoolDivisionViewEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ExtensionPoolEntityListing.md b/build/docs/ExtensionPoolEntityListing.md
index 0d8781fea..bb9c63dc6 100644
--- a/build/docs/ExtensionPoolEntityListing.md
+++ b/build/docs/ExtensionPoolEntityListing.md
@@ -12,8 +12,8 @@ title: ExtensionPoolEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ExternalContactsApi.md b/build/docs/ExternalContactsApi.md
index 9fdd5ff0b..fe25f104b 100644
--- a/build/docs/ExternalContactsApi.md
+++ b/build/docs/ExternalContactsApi.md
@@ -11,6 +11,7 @@ All URIs are relative to *https://api.mypurecloud.com*
|[**delete_externalcontacts_contact**](ExternalContactsApi.html#delete_externalcontacts_contact) | Delete an external contact|
|[**delete_externalcontacts_contact_note**](ExternalContactsApi.html#delete_externalcontacts_contact_note) | Delete a note for an external contact|
|[**delete_externalcontacts_contacts_schema**](ExternalContactsApi.html#delete_externalcontacts_contacts_schema) | Delete a schema|
+|[**delete_externalcontacts_externalsource**](ExternalContactsApi.html#delete_externalcontacts_externalsource) | 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.|
|[**delete_externalcontacts_organization**](ExternalContactsApi.html#delete_externalcontacts_organization) | Delete an external organization|
|[**delete_externalcontacts_organization_note**](ExternalContactsApi.html#delete_externalcontacts_organization_note) | Delete a note for an external organization|
|[**delete_externalcontacts_organization_trustor**](ExternalContactsApi.html#delete_externalcontacts_organization_trustor) | Unlink the Trustor for this External Organization|
@@ -26,6 +27,8 @@ All URIs are relative to *https://api.mypurecloud.com*
|[**get_externalcontacts_contacts_schema_version**](ExternalContactsApi.html#get_externalcontacts_contacts_schema_version) | Get a specific version of a schema|
|[**get_externalcontacts_contacts_schema_versions**](ExternalContactsApi.html#get_externalcontacts_contacts_schema_versions) | Get all versions of an external contact's schema|
|[**get_externalcontacts_contacts_schemas**](ExternalContactsApi.html#get_externalcontacts_contacts_schemas) | Get a list of schemas.|
+|[**get_externalcontacts_externalsource**](ExternalContactsApi.html#get_externalcontacts_externalsource) | Fetch an External Source|
+|[**get_externalcontacts_externalsources**](ExternalContactsApi.html#get_externalcontacts_externalsources) | Fetch a list of External Sources|
|[**get_externalcontacts_organization**](ExternalContactsApi.html#get_externalcontacts_organization) | Fetch an external organization|
|[**get_externalcontacts_organization_contacts**](ExternalContactsApi.html#get_externalcontacts_organization_contacts) | Search for external contacts in an external organization|
|[**get_externalcontacts_organization_note**](ExternalContactsApi.html#get_externalcontacts_organization_note) | Fetch a note for an external organization|
@@ -64,6 +67,7 @@ All URIs are relative to *https://api.mypurecloud.com*
|[**post_externalcontacts_contact_promotion**](ExternalContactsApi.html#post_externalcontacts_contact_promotion) | Promote an observed contact (ephemeral or identified) to a curated contact|
|[**post_externalcontacts_contacts**](ExternalContactsApi.html#post_externalcontacts_contacts) | Create an external contact|
|[**post_externalcontacts_contacts_schemas**](ExternalContactsApi.html#post_externalcontacts_contacts_schemas) | Create a schema|
+|[**post_externalcontacts_externalsources**](ExternalContactsApi.html#post_externalcontacts_externalsources) | Create an External Source|
|[**post_externalcontacts_identifierlookup**](ExternalContactsApi.html#post_externalcontacts_identifierlookup) | Fetch a contact using an identifier type and value.|
|[**post_externalcontacts_merge_contacts**](ExternalContactsApi.html#post_externalcontacts_merge_contacts) | Merge two contacts into a new contact record|
|[**post_externalcontacts_organization_notes**](ExternalContactsApi.html#post_externalcontacts_organization_notes) | Create a note for an external organization|
@@ -74,6 +78,7 @@ All URIs are relative to *https://api.mypurecloud.com*
|[**put_externalcontacts_contact_note**](ExternalContactsApi.html#put_externalcontacts_contact_note) | Update a note for an external contact|
|[**put_externalcontacts_contacts_schema**](ExternalContactsApi.html#put_externalcontacts_contacts_schema) | Update a schema|
|[**put_externalcontacts_conversation**](ExternalContactsApi.html#put_externalcontacts_conversation) | Associate/disassociate an external contact with a conversation|
+|[**put_externalcontacts_externalsource**](ExternalContactsApi.html#put_externalcontacts_externalsource) | Update an External Source|
|[**put_externalcontacts_organization**](ExternalContactsApi.html#put_externalcontacts_organization) | Update an external organization|
|[**put_externalcontacts_organization_note**](ExternalContactsApi.html#put_externalcontacts_organization_note) | Update a note for an external organization|
|[**put_externalcontacts_organization_trustor_trustor_id**](ExternalContactsApi.html#put_externalcontacts_organization_trustor_trustor_id) | Links a Trustor with an External Organization|
@@ -231,6 +236,57 @@ except ApiException as e:
void (empty response body)
+
+
+## object** delete_externalcontacts_externalsource(external_source_id)
+
+
+
+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.
+
+delete_externalcontacts_externalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+
+Wraps DELETE /api/v2/externalcontacts/externalsources/{externalSourceId}
+
+Requires ANY permissions:
+
+* externalContacts:externalSource:delete
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.ExternalContactsApi()
+external_source_id = 'external_source_id_example' # str | External Source ID
+
+try:
+ # 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.
+ api_response = api_instance.delete_externalcontacts_externalsource(external_source_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ExternalContactsApi->delete_externalcontacts_externalsource: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **external_source_id** | **str**| External Source ID | |
+{: class="table table-striped"}
+
+### Return type
+
+**object**
+
## object** delete_externalcontacts_organization(external_organization_id)
@@ -460,7 +516,7 @@ PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ExternalContactsApi()
contact_id = 'contact_id_example' # str | ExternalContact ID
-expand = ['expand_example'] # list[str] | which fields, if any, to expand (externalOrganization,externalDataSources,identifiers) (optional)
+expand = ['expand_example'] # list[str] | which fields, if any, to expand (optional)
try:
# Fetch an external contact
@@ -476,7 +532,7 @@ except ApiException as e:
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **contact_id** | **str**| ExternalContact ID | |
-| **expand** | [**list[str]**](str.html)| which fields, if any, to expand (externalOrganization,externalDataSources,identifiers) | [optional]
**Values**: externalOrganization, externalDataSources, identifiers |
+| **expand** | [**list[str]**](str.html)| which fields, if any, to expand | [optional]
**Values**: externalOrganization, externalDataSources, identifiers, externalSources |
{: class="table table-striped"}
### Return type
@@ -801,7 +857,7 @@ except ApiException as e:
| **page_number** | **int**| Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) | [optional] [default to 1] |
| **q** | **str**| User supplied search keywords (no special syntax is currently supported) | [optional] |
| **sort_order** | **str**| The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \"firstName:asc\", \"title:desc\" | [optional] |
-| **expand** | [**list[str]**](str.html)| which fields, if any, to expand | [optional]
**Values**: externalOrganization, externalDataSources, identifiers |
+| **expand** | [**list[str]**](str.html)| which fields, if any, to expand | [optional]
**Values**: externalOrganization, externalDataSources, identifiers, externalSources |
{: class="table table-striped"}
### Return type
@@ -1002,6 +1058,118 @@ This endpoint does not need any parameters.
[**DataSchemaListing**](DataSchemaListing.html)
+
+
+## [**ExternalSource**](ExternalSource.html) get_externalcontacts_externalsource(external_source_id)
+
+
+
+Fetch an External Source
+
+get_externalcontacts_externalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+
+Wraps GET /api/v2/externalcontacts/externalsources/{externalSourceId}
+
+Requires ANY permissions:
+
+* externalContacts:externalSource:view
+* externalContacts:contact:view
+* externalContacts:externalOrganization:view
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.ExternalContactsApi()
+external_source_id = 'external_source_id_example' # str | External Source ID
+
+try:
+ # Fetch an External Source
+ api_response = api_instance.get_externalcontacts_externalsource(external_source_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ExternalContactsApi->get_externalcontacts_externalsource: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **external_source_id** | **str**| External Source ID | |
+{: class="table table-striped"}
+
+### Return type
+
+[**ExternalSource**](ExternalSource.html)
+
+
+
+## [**CursorExternalSourceListing**](CursorExternalSourceListing.html) get_externalcontacts_externalsources(cursor=cursor, limit=limit, name=name, active=active)
+
+
+
+Fetch a list of External Sources
+
+get_externalcontacts_externalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+
+Wraps GET /api/v2/externalcontacts/externalsources
+
+Requires ANY permissions:
+
+* externalContacts:externalSource:view
+* externalContacts:contact:view
+* externalContacts:externalOrganization:view
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.ExternalContactsApi()
+cursor = 'cursor_example' # str | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional)
+limit = 56 # int | The number of ExternalSources per page; must be between 10 and 200, default is 100 (optional)
+name = 'name_example' # str | Filter by external source name. Filtering is prefix filtering and not an exact match (optional)
+active = True # bool | Filter by active status of external source (optional)
+
+try:
+ # Fetch a list of External Sources
+ api_response = api_instance.get_externalcontacts_externalsources(cursor=cursor, limit=limit, name=name, active=active)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ExternalContactsApi->get_externalcontacts_externalsources: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cursor** | **str**| Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL | [optional] |
+| **limit** | **int**| The number of ExternalSources per page; must be between 10 and 200, default is 100 | [optional] |
+| **name** | **str**| Filter by external source name. Filtering is prefix filtering and not an exact match | [optional] |
+| **active** | **bool**| Filter by active status of external source | [optional] |
+{: class="table table-striped"}
+
+### Return type
+
+[**CursorExternalSourceListing**](CursorExternalSourceListing.html)
+
## [**ExternalOrganization**](ExternalOrganization.html) get_externalcontacts_organization(external_organization_id, expand=expand, include_trustors=include_trustors)
@@ -1109,7 +1277,7 @@ except ApiException as e:
| **page_number** | **int**| Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) | [optional] [default to 1] |
| **q** | **str**| User supplied search keywords (no special syntax is currently supported) | [optional] |
| **sort_order** | **str**| The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \"firstName:asc\", \"title:desc\" | [optional] |
-| **expand** | [**list[str]**](str.html)| which fields, if any, to expand | [optional]
**Values**: externalOrganization, externalDataSources, identifiers |
+| **expand** | [**list[str]**](str.html)| which fields, if any, to expand | [optional]
**Values**: externalOrganization, externalDataSources, identifiers, externalSources |
{: class="table table-striped"}
### Return type
@@ -2945,6 +3113,57 @@ except ApiException as e:
[**DataSchema**](DataSchema.html)
+
+
+## [**ExternalSource**](ExternalSource.html) post_externalcontacts_externalsources(body)
+
+
+
+Create an External Source
+
+post_externalcontacts_externalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+
+Wraps POST /api/v2/externalcontacts/externalsources
+
+Requires ANY permissions:
+
+* externalContacts:externalSource:add
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.ExternalContactsApi()
+body = PureCloudPlatformClientV2.ExternalSource() # ExternalSource | External Source
+
+try:
+ # Create an External Source
+ api_response = api_instance.post_externalcontacts_externalsources(body)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ExternalContactsApi->post_externalcontacts_externalsources: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | [**ExternalSource**](ExternalSource.html)| External Source | |
+{: class="table table-striped"}
+
+### Return type
+
+[**ExternalSource**](ExternalSource.html)
+
## [**ExternalContact**](ExternalContact.html) post_externalcontacts_identifierlookup(identifier, expand=expand)
@@ -2992,7 +3211,7 @@ except ApiException as e:
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **identifier** | [**ContactIdentifier**](ContactIdentifier.html)| | |
-| **expand** | [**list[str]**](str.html)| which field, if any, to expand | [optional]
**Values**: externalOrganization, identifiers |
+| **expand** | [**list[str]**](str.html)| which field, if any, to expand | [optional]
**Values**: externalOrganization, identifiers, externalSources |
{: class="table table-striped"}
### Return type
@@ -3461,6 +3680,59 @@ except ApiException as e:
void (empty response body)
+
+
+## [**ExternalSource**](ExternalSource.html) put_externalcontacts_externalsource(external_source_id, body)
+
+
+
+Update an External Source
+
+put_externalcontacts_externalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+
+Wraps PUT /api/v2/externalcontacts/externalsources/{externalSourceId}
+
+Requires ANY permissions:
+
+* externalContacts:externalSource:edit
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.ExternalContactsApi()
+external_source_id = 'external_source_id_example' # str | External Source ID
+body = PureCloudPlatformClientV2.ExternalSource() # ExternalSource | External Source
+
+try:
+ # Update an External Source
+ api_response = api_instance.put_externalcontacts_externalsource(external_source_id, body)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ExternalContactsApi->put_externalcontacts_externalsource: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **external_source_id** | **str**| External Source ID | |
+| **body** | [**ExternalSource**](ExternalSource.html)| External Source | |
+{: class="table table-striped"}
+
+### Return type
+
+[**ExternalSource**](ExternalSource.html)
+
## [**ExternalOrganization**](ExternalOrganization.html) put_externalcontacts_organization(external_organization_id, body)
diff --git a/build/docs/ExternalMetricDefinitionListing.md b/build/docs/ExternalMetricDefinitionListing.md
index 9981c1efa..aea3e7777 100644
--- a/build/docs/ExternalMetricDefinitionListing.md
+++ b/build/docs/ExternalMetricDefinitionListing.md
@@ -11,8 +11,8 @@ title: ExternalMetricDefinitionListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ExternalOrganizationListing.md b/build/docs/ExternalOrganizationListing.md
index 8e562c584..bfdbb9b57 100644
--- a/build/docs/ExternalOrganizationListing.md
+++ b/build/docs/ExternalOrganizationListing.md
@@ -12,8 +12,8 @@ title: ExternalOrganizationListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **partial_results** | **bool** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/FacebookIntegrationEntityListing.md b/build/docs/FacebookIntegrationEntityListing.md
index 6ee41da1e..f4a1bb9ee 100644
--- a/build/docs/FacebookIntegrationEntityListing.md
+++ b/build/docs/FacebookIntegrationEntityListing.md
@@ -11,8 +11,8 @@ title: FacebookIntegrationEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/FailedRecordingEntityListing.md b/build/docs/FailedRecordingEntityListing.md
index e827550de..0f8d92875 100644
--- a/build/docs/FailedRecordingEntityListing.md
+++ b/build/docs/FailedRecordingEntityListing.md
@@ -11,8 +11,8 @@ title: FailedRecordingEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/Fallback.md b/build/docs/Fallback.md
new file mode 100644
index 000000000..0357618d5
--- /dev/null
+++ b/build/docs/Fallback.md
@@ -0,0 +1,14 @@
+---
+title: Fallback
+---
+## Fallback
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **enabled** | **bool** | Fallback actions are enabled. | [optional] |
+| **actions** | [**list[CopilotFallbackAction]**](CopilotFallbackAction.html) | Fallback actions. | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/FaxDocumentEntityListing.md b/build/docs/FaxDocumentEntityListing.md
index 4312a796e..6f13600ec 100644
--- a/build/docs/FaxDocumentEntityListing.md
+++ b/build/docs/FaxDocumentEntityListing.md
@@ -11,8 +11,8 @@ title: FaxDocumentEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/FileSpecificationTemplateEntityListing.md b/build/docs/FileSpecificationTemplateEntityListing.md
index fbd145682..cf85c2ba9 100644
--- a/build/docs/FileSpecificationTemplateEntityListing.md
+++ b/build/docs/FileSpecificationTemplateEntityListing.md
@@ -11,8 +11,8 @@ title: FileSpecificationTemplateEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/FlowDivisionViewEntityListing.md b/build/docs/FlowDivisionViewEntityListing.md
index 7f858825f..3f3ede021 100644
--- a/build/docs/FlowDivisionViewEntityListing.md
+++ b/build/docs/FlowDivisionViewEntityListing.md
@@ -11,8 +11,8 @@ title: FlowDivisionViewEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/FlowEntityListing.md b/build/docs/FlowEntityListing.md
index 10d004db7..e5462f98a 100644
--- a/build/docs/FlowEntityListing.md
+++ b/build/docs/FlowEntityListing.md
@@ -11,8 +11,8 @@ title: FlowEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/FlowMilestoneDivisionViewEntityListing.md b/build/docs/FlowMilestoneDivisionViewEntityListing.md
index 07cccd6f2..36da5b19a 100644
--- a/build/docs/FlowMilestoneDivisionViewEntityListing.md
+++ b/build/docs/FlowMilestoneDivisionViewEntityListing.md
@@ -11,8 +11,8 @@ title: FlowMilestoneDivisionViewEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/FlowMilestoneListing.md b/build/docs/FlowMilestoneListing.md
index f1df70fd6..380b24414 100644
--- a/build/docs/FlowMilestoneListing.md
+++ b/build/docs/FlowMilestoneListing.md
@@ -11,8 +11,8 @@ title: FlowMilestoneListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/FlowOutcomeDivisionViewEntityListing.md b/build/docs/FlowOutcomeDivisionViewEntityListing.md
index d94e8a566..18b60238d 100644
--- a/build/docs/FlowOutcomeDivisionViewEntityListing.md
+++ b/build/docs/FlowOutcomeDivisionViewEntityListing.md
@@ -11,8 +11,8 @@ title: FlowOutcomeDivisionViewEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/FlowOutcomeListing.md b/build/docs/FlowOutcomeListing.md
index ee9b207e2..d43429778 100644
--- a/build/docs/FlowOutcomeListing.md
+++ b/build/docs/FlowOutcomeListing.md
@@ -11,8 +11,8 @@ title: FlowOutcomeListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/FlowResultEntityListing.md b/build/docs/FlowResultEntityListing.md
index 98d52daf5..d0d4cee8c 100644
--- a/build/docs/FlowResultEntityListing.md
+++ b/build/docs/FlowResultEntityListing.md
@@ -11,8 +11,8 @@ title: FlowResultEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/FlowSettingsResponseEntityListing.md b/build/docs/FlowSettingsResponseEntityListing.md
index cb484109c..9d5492192 100644
--- a/build/docs/FlowSettingsResponseEntityListing.md
+++ b/build/docs/FlowSettingsResponseEntityListing.md
@@ -11,8 +11,8 @@ title: FlowSettingsResponseEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/FlowVersionEntityListing.md b/build/docs/FlowVersionEntityListing.md
index c2e3db368..98a4bfed6 100644
--- a/build/docs/FlowVersionEntityListing.md
+++ b/build/docs/FlowVersionEntityListing.md
@@ -11,8 +11,8 @@ title: FlowVersionEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/Function.md b/build/docs/Function.md
index f0b79ea97..b73e46607 100644
--- a/build/docs/Function.md
+++ b/build/docs/Function.md
@@ -14,7 +14,7 @@ title: Function
| **zip_id** | **str** | Zip file identifier. | [optional] |
| **handler** | **str** | Handler entry point into zip file to execute function. Should be path within upload function package to the invocation module without language extension, followed by a period and then exported invocation method name. e.g. 'src/index.handler' | |
| **runtime** | **str** | Runtime required for execution. Valid runtimes change over time as versions are deprecated. Use /api/v2/integrations/actions/functions/runtimes for current list. | |
-| **timeout_seconds** | **int** | Execution timeout to apply to function. Value is in seconds. Range allowed 1 to 60. Default value 15 seconds. | [optional] |
+| **timeout_seconds** | **int** | Execution timeout to apply to function. Value is in seconds. Range allowed 1 to 15. Default value 15 seconds. | [optional] |
{: class="table table-striped"}
diff --git a/build/docs/FunctionConfig.md b/build/docs/FunctionConfig.md
index fe460d3fa..25ed7535a 100644
--- a/build/docs/FunctionConfig.md
+++ b/build/docs/FunctionConfig.md
@@ -10,6 +10,7 @@ title: FunctionConfig
| **id** | **str** | Action identifier. | [optional] |
| **function** | [**Function**](Function.html) | Function configuration. | [optional] |
| **zip** | [**FunctionZipConfig**](FunctionZipConfig.html) | Zip file configuration and state. | [optional] |
+| **upload_exception_history** | [**list[FunctionZipConfig]**](FunctionZipConfig.html) | History of failed zip upload file configuration including their state and error messages. Contains no more than last ten failures. | [optional] |
| **self_uri** | **str** | The URI for this object | [optional] |
{: class="table table-striped"}
diff --git a/build/docs/FunctionZipConfig.md b/build/docs/FunctionZipConfig.md
index 88fed1b35..f1026c2fc 100644
--- a/build/docs/FunctionZipConfig.md
+++ b/build/docs/FunctionZipConfig.md
@@ -11,6 +11,8 @@ title: FunctionZipConfig
| **id** | **str** | Zip file Identifier | [optional] |
| **name** | **str** | Zip file name | [optional] |
| **date_created** | **datetime** | Date and time zip record was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z | [optional] |
+| **error_message** | **str** | Error message if upload failed. | [optional] |
+| **request_id** | **str** | Upload request id used for zip upload | [optional] |
{: class="table table-striped"}
diff --git a/build/docs/GDPRRequestEntityListing.md b/build/docs/GDPRRequestEntityListing.md
index 6e78e79b7..68879613f 100644
--- a/build/docs/GDPRRequestEntityListing.md
+++ b/build/docs/GDPRRequestEntityListing.md
@@ -11,8 +11,8 @@ title: GDPRRequestEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/GDPRSubjectEntityListing.md b/build/docs/GDPRSubjectEntityListing.md
index 597f9fecf..c27874f47 100644
--- a/build/docs/GDPRSubjectEntityListing.md
+++ b/build/docs/GDPRSubjectEntityListing.md
@@ -11,8 +11,8 @@ title: GDPRSubjectEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/GetCelebrationListing.md b/build/docs/GetCelebrationListing.md
index f8e2680f8..c2b8d2ee6 100644
--- a/build/docs/GetCelebrationListing.md
+++ b/build/docs/GetCelebrationListing.md
@@ -11,8 +11,8 @@ title: GetCelebrationListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/GoogleDialogflowConfig.md b/build/docs/GoogleDialogflowConfig.md
new file mode 100644
index 000000000..98e0e687f
--- /dev/null
+++ b/build/docs/GoogleDialogflowConfig.md
@@ -0,0 +1,14 @@
+---
+title: GoogleDialogflowConfig
+---
+## GoogleDialogflowConfig
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **integration_id** | **str** | The integration identifier with which the assistant will fetch transcriptions and knowledge suggestions. | [optional] |
+| **conversation_profiles** | [**list[ConversationProfile]**](ConversationProfile.html) | The conversation profiles for which the assistant will fetch transcription and knowledge suggestions. | |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/GrammarListing.md b/build/docs/GrammarListing.md
index 9048fc7e3..1e20388da 100644
--- a/build/docs/GrammarListing.md
+++ b/build/docs/GrammarListing.md
@@ -11,8 +11,8 @@ title: GrammarListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/GreetingListing.md b/build/docs/GreetingListing.md
index f13e5cd9e..35e1c166c 100644
--- a/build/docs/GreetingListing.md
+++ b/build/docs/GreetingListing.md
@@ -11,8 +11,8 @@ title: GreetingListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/GroupEntityListing.md b/build/docs/GroupEntityListing.md
index 66e9768d3..37d826bf5 100644
--- a/build/docs/GroupEntityListing.md
+++ b/build/docs/GroupEntityListing.md
@@ -11,8 +11,8 @@ title: GroupEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/GroupProfileEntityListing.md b/build/docs/GroupProfileEntityListing.md
index afd596a0c..0c8f73fd0 100644
--- a/build/docs/GroupProfileEntityListing.md
+++ b/build/docs/GroupProfileEntityListing.md
@@ -11,8 +11,8 @@ title: GroupProfileEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/IVRDivisionViewEntityListing.md b/build/docs/IVRDivisionViewEntityListing.md
index eab36072e..03d1ac2b8 100644
--- a/build/docs/IVRDivisionViewEntityListing.md
+++ b/build/docs/IVRDivisionViewEntityListing.md
@@ -12,8 +12,8 @@ title: IVRDivisionViewEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/IVREntityListing.md b/build/docs/IVREntityListing.md
index 98cec03ab..48fd6b5f7 100644
--- a/build/docs/IVREntityListing.md
+++ b/build/docs/IVREntityListing.md
@@ -12,8 +12,8 @@ title: IVREntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/IdentityProviderEntityListing.md b/build/docs/IdentityProviderEntityListing.md
index d12a4cae7..bc4df53fb 100644
--- a/build/docs/IdentityProviderEntityListing.md
+++ b/build/docs/IdentityProviderEntityListing.md
@@ -11,8 +11,8 @@ title: IdentityProviderEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ImportTemplateEntityListing.md b/build/docs/ImportTemplateEntityListing.md
index 72f26833c..fe1367b45 100644
--- a/build/docs/ImportTemplateEntityListing.md
+++ b/build/docs/ImportTemplateEntityListing.md
@@ -11,8 +11,8 @@ title: ImportTemplateEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/InboundDomainEntityListing.md b/build/docs/InboundDomainEntityListing.md
index d0c8bdd6f..d175a1436 100644
--- a/build/docs/InboundDomainEntityListing.md
+++ b/build/docs/InboundDomainEntityListing.md
@@ -11,8 +11,8 @@ title: InboundDomainEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/InboundRouteEntityListing.md b/build/docs/InboundRouteEntityListing.md
index 2aaa935b3..d34a12ef2 100644
--- a/build/docs/InboundRouteEntityListing.md
+++ b/build/docs/InboundRouteEntityListing.md
@@ -11,8 +11,8 @@ title: InboundRouteEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/InstagramIntegrationEntityListing.md b/build/docs/InstagramIntegrationEntityListing.md
index c601ce4d8..ad2932729 100644
--- a/build/docs/InstagramIntegrationEntityListing.md
+++ b/build/docs/InstagramIntegrationEntityListing.md
@@ -11,8 +11,8 @@ title: InstagramIntegrationEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/IntegrationEntityListing.md b/build/docs/IntegrationEntityListing.md
index 3d6191b7c..ed4cc4ba7 100644
--- a/build/docs/IntegrationEntityListing.md
+++ b/build/docs/IntegrationEntityListing.md
@@ -11,8 +11,8 @@ title: IntegrationEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/IntegrationTypeEntityListing.md b/build/docs/IntegrationTypeEntityListing.md
index 6fbbbc51a..766ec9b2a 100644
--- a/build/docs/IntegrationTypeEntityListing.md
+++ b/build/docs/IntegrationTypeEntityListing.md
@@ -11,8 +11,8 @@ title: IntegrationTypeEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/InteractionStatsAlertContainer.md b/build/docs/InteractionStatsAlertContainer.md
index 0a6e3a91d..5e23b3d25 100644
--- a/build/docs/InteractionStatsAlertContainer.md
+++ b/build/docs/InteractionStatsAlertContainer.md
@@ -11,8 +11,8 @@ title: InteractionStatsAlertContainer
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/InteractionStatsRuleContainer.md b/build/docs/InteractionStatsRuleContainer.md
index 5c8cdc757..bbe19af9e 100644
--- a/build/docs/InteractionStatsRuleContainer.md
+++ b/build/docs/InteractionStatsRuleContainer.md
@@ -11,8 +11,8 @@ title: InteractionStatsRuleContainer
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/JourneyApi.md b/build/docs/JourneyApi.md
index 418578f52..443105486 100644
--- a/build/docs/JourneyApi.md
+++ b/build/docs/JourneyApi.md
@@ -322,8 +322,6 @@ Delete a Journey View by ID
deletes all versions
-delete_journey_view is a preview method and is subject to both breaking and non-breaking changes at any time without notice
-
Wraps DELETE /api/v2/journey/views/{viewId}
Requires ALL permissions:
@@ -1578,8 +1576,6 @@ Get a Journey View by ID
returns the latest version
-get_journey_view is a preview method and is subject to both breaking and non-breaking changes at any time without notice
-
Wraps GET /api/v2/journey/views/{viewId}
Requires ALL permissions:
@@ -1629,8 +1625,6 @@ except ApiException as e:
Get a Journey View by ID and version
-get_journey_view_version is a preview method and is subject to both breaking and non-breaking changes at any time without notice
-
Wraps GET /api/v2/journey/views/{viewId}/versions/{versionId}
Requires ALL permissions:
@@ -1684,8 +1678,6 @@ Get the job for a journey view version.
used for long descriptions
-get_journey_view_version_job is a preview method and is subject to both breaking and non-breaking changes at any time without notice
-
Wraps GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}
Requires ALL permissions:
@@ -1741,8 +1733,6 @@ Get the result of a job for a journey view version.
used for long descriptions
-get_journey_view_version_job_results is a preview method and is subject to both breaking and non-breaking changes at any time without notice
-
Wraps GET /api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results
Requires ALL permissions:
@@ -1798,8 +1788,6 @@ Get the latest job of a journey view version.
used for long descriptions
-get_journey_view_version_jobs_latest is a preview method and is subject to both breaking and non-breaking changes at any time without notice
-
Wraps GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest
Requires ALL permissions:
@@ -1845,14 +1833,12 @@ except ApiException as e:
-## [**JourneyViewListing**](JourneyViewListing.html) get_journey_views(page_number=page_number, page_size=page_size, name_or_created_by=name_or_created_by, expand=expand)
+## [**JourneyViewListing**](JourneyViewListing.html) get_journey_views(page_number=page_number, page_size=page_size, name_or_created_by=name_or_created_by, expand=expand, id=id)
Get a list of Journey Views
-get_journey_views is a preview method and is subject to both breaking and non-breaking changes at any time without notice
-
Wraps GET /api/v2/journey/views
Requires ALL permissions:
@@ -1876,10 +1862,11 @@ page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
name_or_created_by = 'name_or_created_by_example' # str | Journey View Name or Created By (optional)
expand = 'expand_example' # str | Parameter to request additional data to return in Journey payload (optional)
+id = 'id_example' # str | Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items. (optional)
try:
# Get a list of Journey Views
- api_response = api_instance.get_journey_views(page_number=page_number, page_size=page_size, name_or_created_by=name_or_created_by, expand=expand)
+ api_response = api_instance.get_journey_views(page_number=page_number, page_size=page_size, name_or_created_by=name_or_created_by, expand=expand, id=id)
pprint(api_response)
except ApiException as e:
print("Exception when calling JourneyApi->get_journey_views: %s\n" % e)
@@ -1894,6 +1881,7 @@ except ApiException as e:
| **page_size** | **int**| Page size | [optional] [default to 25] |
| **name_or_created_by** | **str**| Journey View Name or Created By | [optional] |
| **expand** | **str**| Parameter to request additional data to return in Journey payload | [optional]
**Values**: charts |
+| **id** | **str**| Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items. | [optional] |
{: class="table table-striped"}
### Return type
@@ -2006,8 +1994,6 @@ This endpoint does not need any parameters.
Get the jobs for an organization.
-get_journey_views_jobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
-
Wraps GET /api/v2/journey/views/jobs
Requires ALL permissions:
@@ -2954,8 +2940,6 @@ Submit a job request for a journey view version.
used for long descriptions
-post_journey_view_version_jobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
-
Wraps POST /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs
Requires ALL permissions:
@@ -3009,8 +2993,6 @@ Update a Journey View by ID
creates a new version
-post_journey_view_versions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
-
Wraps POST /api/v2/journey/views/{viewId}/versions
Requires ALL permissions:
@@ -3062,8 +3044,6 @@ except ApiException as e:
Create a new Journey View
-post_journey_views is a preview method and is subject to both breaking and non-breaking changes at any time without notice
-
Wraps POST /api/v2/journey/views
Requires ALL permissions:
diff --git a/build/docs/JourneyViewElementFilterRangeData.md b/build/docs/JourneyViewElementFilterRangeData.md
index 628fbb3ed..a678d4e9c 100644
--- a/build/docs/JourneyViewElementFilterRangeData.md
+++ b/build/docs/JourneyViewElementFilterRangeData.md
@@ -7,8 +7,8 @@ title: JourneyViewElementFilterRangeData
|Name | Type | Description | Notes|
|------------ | ------------- | ------------- | -------------|
-| **duration** | **str** | an ISO 8601 time duration.Only one of number or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | [optional] |
-| **number** | **int** | an Integer value.Only one of number or duration must be specified. | [optional] |
+| **duration** | **str** | An ISO 8601 time duration. Only one of number or duration must be specified. | [optional] |
+| **number** | **float** | A numeric value. Only one of number or duration must be specified. | [optional] |
{: class="table table-striped"}
diff --git a/build/docs/JourneyViewJobListing.md b/build/docs/JourneyViewJobListing.md
index a2de8c6e1..397aa5b90 100644
--- a/build/docs/JourneyViewJobListing.md
+++ b/build/docs/JourneyViewJobListing.md
@@ -11,8 +11,8 @@ title: JourneyViewJobListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/JourneyViewListing.md b/build/docs/JourneyViewListing.md
index 19e4c44e6..e1a37f8d3 100644
--- a/build/docs/JourneyViewListing.md
+++ b/build/docs/JourneyViewListing.md
@@ -11,8 +11,8 @@ title: JourneyViewListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/KnowledgeAnswerConfig.md b/build/docs/KnowledgeAnswerConfig.md
new file mode 100644
index 000000000..0231630cf
--- /dev/null
+++ b/build/docs/KnowledgeAnswerConfig.md
@@ -0,0 +1,13 @@
+---
+title: KnowledgeAnswerConfig
+---
+## KnowledgeAnswerConfig
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **enabled** | **bool** | Knowledge answer is enabled. | |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/KnowledgeAnswerDocumentResponse.md b/build/docs/KnowledgeAnswerDocumentResponse.md
new file mode 100644
index 000000000..3761464dd
--- /dev/null
+++ b/build/docs/KnowledgeAnswerDocumentResponse.md
@@ -0,0 +1,16 @@
+---
+title: KnowledgeAnswerDocumentResponse
+---
+## KnowledgeAnswerDocumentResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **str** | The document id. | [optional] |
+| **title** | **str** | The document title. | [optional] |
+| **answer** | **str** | The answer found inside a variationContent. | [optional] |
+| **variation** | [**DocumentVariationAnswer**](DocumentVariationAnswer.html) | The variation with the answer's highlight data. | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/KnowledgeAnswerDocumentsResponse.md b/build/docs/KnowledgeAnswerDocumentsResponse.md
new file mode 100644
index 000000000..09be72245
--- /dev/null
+++ b/build/docs/KnowledgeAnswerDocumentsResponse.md
@@ -0,0 +1,14 @@
+---
+title: KnowledgeAnswerDocumentsResponse
+---
+## KnowledgeAnswerDocumentsResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **results** | [**list[KnowledgeAnswerDocumentResponse]**](KnowledgeAnswerDocumentResponse.html) | The results with answers if the answerMode request property is not set or contains \"AnswerHighlight\". Empty array otherwise. | [optional] |
+| **answer_generation** | [**KnowledgeAnswerGenerationResponse**](KnowledgeAnswerGenerationResponse.html) | The results with AI-generated answer if the answerMode request property contains \"AnswerGeneration\". | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/KnowledgeApi.md b/build/docs/KnowledgeApi.md
index 7ef3fbfd5..5a899924f 100644
--- a/build/docs/KnowledgeApi.md
+++ b/build/docs/KnowledgeApi.md
@@ -58,6 +58,7 @@ All URIs are relative to *https://api.mypurecloud.com*
|[**patch_knowledge_knowledgebase**](KnowledgeApi.html#patch_knowledge_knowledgebase) | Update knowledge base|
|[**patch_knowledge_knowledgebase_category**](KnowledgeApi.html#patch_knowledge_knowledgebase_category) | Update category|
|[**patch_knowledge_knowledgebase_document**](KnowledgeApi.html#patch_knowledge_knowledgebase_document) | Update document.|
+|[**patch_knowledge_knowledgebase_document_feedback_feedback_id**](KnowledgeApi.html#patch_knowledge_knowledgebase_document_feedback_feedback_id) | Update feedback on a document|
|[**patch_knowledge_knowledgebase_document_variation**](KnowledgeApi.html#patch_knowledge_knowledgebase_document_variation) | Update a variation for a document.|
|[**patch_knowledge_knowledgebase_documents_search_search_id**](KnowledgeApi.html#patch_knowledge_knowledgebase_documents_search_search_id) | Update search result.|
|[**patch_knowledge_knowledgebase_import_job**](KnowledgeApi.html#patch_knowledge_knowledgebase_import_job) | Start import job|
@@ -72,6 +73,7 @@ All URIs are relative to *https://api.mypurecloud.com*
|[**post_knowledge_guest_session_document_copies**](KnowledgeApi.html#post_knowledge_guest_session_document_copies) | Indicate that the document was copied by the user.|
|[**post_knowledge_guest_session_document_feedback**](KnowledgeApi.html#post_knowledge_guest_session_document_feedback) | Give feedback on a document|
|[**post_knowledge_guest_session_document_views**](KnowledgeApi.html#post_knowledge_guest_session_document_views) | Create view event for a document.|
+|[**post_knowledge_guest_session_documents_answers**](KnowledgeApi.html#post_knowledge_guest_session_documents_answers) | Answer documents.|
|[**post_knowledge_guest_session_documents_presentations**](KnowledgeApi.html#post_knowledge_guest_session_documents_presentations) | Indicate that documents were presented to the user.|
|[**post_knowledge_guest_session_documents_search**](KnowledgeApi.html#post_knowledge_guest_session_documents_search) | Search the documents in a guest session.|
|[**post_knowledge_guest_session_documents_search_suggestions**](KnowledgeApi.html#post_knowledge_guest_session_documents_search_suggestions) | Query the knowledge documents to provide suggestions for auto completion.|
@@ -83,6 +85,7 @@ All URIs are relative to *https://api.mypurecloud.com*
|[**post_knowledge_knowledgebase_document_versions**](KnowledgeApi.html#post_knowledge_knowledgebase_document_versions) | Creates or restores a document version.|
|[**post_knowledge_knowledgebase_document_views**](KnowledgeApi.html#post_knowledge_knowledgebase_document_views) | Create view for a document.|
|[**post_knowledge_knowledgebase_documents**](KnowledgeApi.html#post_knowledge_knowledgebase_documents) | Create document.|
+|[**post_knowledge_knowledgebase_documents_answers**](KnowledgeApi.html#post_knowledge_knowledgebase_documents_answers) | Answer documents.|
|[**post_knowledge_knowledgebase_documents_bulk_remove**](KnowledgeApi.html#post_knowledge_knowledgebase_documents_bulk_remove) | Bulk remove documents.|
|[**post_knowledge_knowledgebase_documents_bulk_update**](KnowledgeApi.html#post_knowledge_knowledgebase_documents_bulk_update) | Bulk update documents.|
|[**post_knowledge_knowledgebase_documents_presentations**](KnowledgeApi.html#post_knowledge_knowledgebase_documents_presentations) | Indicate that documents were presented to the user.|
@@ -2879,6 +2882,61 @@ except ApiException as e:
[**KnowledgeDocumentResponse**](KnowledgeDocumentResponse.html)
+
+
+## [**KnowledgeDocumentFeedbackResponse**](KnowledgeDocumentFeedbackResponse.html) patch_knowledge_knowledgebase_document_feedback_feedback_id(knowledge_base_id, document_id, feedback_id, body=body)
+
+
+
+Update feedback on a document
+
+Wraps PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}
+
+Requires ANY permissions:
+
+* knowledge:feedback:edit
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.KnowledgeApi()
+knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID.
+document_id = 'document_id_example' # str | Document ID.
+feedback_id = 'feedback_id_example' # str | Feedback ID.
+body = PureCloudPlatformClientV2.KnowledgeDocumentFeedbackUpdateRequest() # KnowledgeDocumentFeedbackUpdateRequest | (optional)
+
+try:
+ # Update feedback on a document
+ api_response = api_instance.patch_knowledge_knowledgebase_document_feedback_feedback_id(knowledge_base_id, document_id, feedback_id, body=body)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling KnowledgeApi->patch_knowledge_knowledgebase_document_feedback_feedback_id: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **knowledge_base_id** | **str**| Knowledge base ID. | |
+| **document_id** | **str**| Document ID. | |
+| **feedback_id** | **str**| Feedback ID. | |
+| **body** | [**KnowledgeDocumentFeedbackUpdateRequest**](KnowledgeDocumentFeedbackUpdateRequest.html)| | [optional] |
+{: class="table table-striped"}
+
+### Return type
+
+[**KnowledgeDocumentFeedbackResponse**](KnowledgeDocumentFeedbackResponse.html)
+
## [**DocumentVariation**](DocumentVariation.html) patch_knowledge_knowledgebase_document_variation(document_variation_id, document_id, knowledge_base_id, body)
@@ -3615,6 +3673,53 @@ except ApiException as e:
void (empty response body)
+
+
+## [**KnowledgeGuestAnswerDocumentsResponse**](KnowledgeGuestAnswerDocumentsResponse.html) post_knowledge_guest_session_documents_answers(session_id, body)
+
+
+
+Answer documents.
+
+Wraps POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/answers
+
+Requires no permissions
+
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.KnowledgeApi()
+session_id = 'session_id_example' # str | Knowledge guest session ID.
+body = PureCloudPlatformClientV2.KnowledgeDocumentsAnswerFilter() # KnowledgeDocumentsAnswerFilter |
+
+try:
+ # Answer documents.
+ api_response = api_instance.post_knowledge_guest_session_documents_answers(session_id, body)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling KnowledgeApi->post_knowledge_guest_session_documents_answers: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **session_id** | **str**| Knowledge guest session ID. | |
+| **body** | [**KnowledgeDocumentsAnswerFilter**](KnowledgeDocumentsAnswerFilter.html)| | |
+{: class="table table-striped"}
+
+### Return type
+
+[**KnowledgeGuestAnswerDocumentsResponse**](KnowledgeGuestAnswerDocumentsResponse.html)
+
## post_knowledge_guest_session_documents_presentations(session_id, body=body)
@@ -4168,6 +4273,58 @@ except ApiException as e:
[**KnowledgeDocumentResponse**](KnowledgeDocumentResponse.html)
+
+
+## [**KnowledgeAnswerDocumentsResponse**](KnowledgeAnswerDocumentsResponse.html) post_knowledge_knowledgebase_documents_answers(knowledge_base_id, body)
+
+
+
+Answer documents.
+
+Wraps POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/answers
+
+Requires ALL permissions:
+
+* knowledge:document:view
+* knowledge:documentAnswer:view
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.KnowledgeApi()
+knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID
+body = PureCloudPlatformClientV2.KnowledgeDocumentsAnswerFilter() # KnowledgeDocumentsAnswerFilter |
+
+try:
+ # Answer documents.
+ api_response = api_instance.post_knowledge_knowledgebase_documents_answers(knowledge_base_id, body)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling KnowledgeApi->post_knowledge_knowledgebase_documents_answers: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **knowledge_base_id** | **str**| Knowledge base ID | |
+| **body** | [**KnowledgeDocumentsAnswerFilter**](KnowledgeDocumentsAnswerFilter.html)| | |
+{: class="table table-striped"}
+
+### Return type
+
+[**KnowledgeAnswerDocumentsResponse**](KnowledgeAnswerDocumentsResponse.html)
+
## [**BulkResponse**](BulkResponse.html) post_knowledge_knowledgebase_documents_bulk_remove(knowledge_base_id, body)
diff --git a/build/docs/KnowledgeBaseWithDialectReference.md b/build/docs/KnowledgeBaseWithDialectReference.md
new file mode 100644
index 000000000..ecc158491
--- /dev/null
+++ b/build/docs/KnowledgeBaseWithDialectReference.md
@@ -0,0 +1,15 @@
+---
+title: KnowledgeBaseWithDialectReference
+---
+## KnowledgeBaseWithDialectReference
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **str** | The globally unique identifier for the knowledge base. | |
+| **language_code** | **str** | The dialect for the knowledge base. | |
+| **self_uri** | **str** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/KnowledgeDocumentFeedbackUpdateRequest.md b/build/docs/KnowledgeDocumentFeedbackUpdateRequest.md
new file mode 100644
index 000000000..4f262bdde
--- /dev/null
+++ b/build/docs/KnowledgeDocumentFeedbackUpdateRequest.md
@@ -0,0 +1,16 @@
+---
+title: KnowledgeDocumentFeedbackUpdateRequest
+---
+## KnowledgeDocumentFeedbackUpdateRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **rating** | **str** | Feedback rating. | |
+| **reason** | **str** | Feedback reason | [optional] |
+| **comment** | **str** | Feedback comment | [optional] |
+| **state** | **str** | Feedback state | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/KnowledgeDocumentsAnswerFilter.md b/build/docs/KnowledgeDocumentsAnswerFilter.md
new file mode 100644
index 000000000..acf48d8f3
--- /dev/null
+++ b/build/docs/KnowledgeDocumentsAnswerFilter.md
@@ -0,0 +1,20 @@
+---
+title: KnowledgeDocumentsAnswerFilter
+---
+## KnowledgeDocumentsAnswerFilter
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **query** | **str** | The search query. | [optional] |
+| **language** | **str** | The language of the documents. | [optional] |
+| **app_type** | **str** | The appType | [optional] |
+| **query_type** | **str** | The query type | [optional] |
+| **search_id** | **str** | The search id. | [optional] |
+| **insert_highlight_into_variation_content** | **bool** | If specified - insert highlight data into the variation content. | [optional] |
+| **answer_mode** | **list[str]** | Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration). Default mode: AnswerHighlight | [optional] |
+| **variation_ids** | **list[str]** | The variation Ids to answer. | |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/KnowledgeGuestAnswerDocumentResponse.md b/build/docs/KnowledgeGuestAnswerDocumentResponse.md
new file mode 100644
index 000000000..d71b9e64c
--- /dev/null
+++ b/build/docs/KnowledgeGuestAnswerDocumentResponse.md
@@ -0,0 +1,16 @@
+---
+title: KnowledgeGuestAnswerDocumentResponse
+---
+## KnowledgeGuestAnswerDocumentResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **str** | The document id. | [optional] |
+| **title** | **str** | The document title. | [optional] |
+| **answer** | **str** | The answer found inside a variationContent. | [optional] |
+| **variation** | [**KnowledgeGuestDocumentVariationAnswer**](KnowledgeGuestDocumentVariationAnswer.html) | The variation with the answer's highlight data. | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/KnowledgeGuestAnswerDocumentsResponse.md b/build/docs/KnowledgeGuestAnswerDocumentsResponse.md
new file mode 100644
index 000000000..64cf021cb
--- /dev/null
+++ b/build/docs/KnowledgeGuestAnswerDocumentsResponse.md
@@ -0,0 +1,13 @@
+---
+title: KnowledgeGuestAnswerDocumentsResponse
+---
+## KnowledgeGuestAnswerDocumentsResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **results** | [**list[KnowledgeGuestAnswerDocumentResponse]**](KnowledgeGuestAnswerDocumentResponse.html) | The results with answers. | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/KnowledgeSuggestionConfig.md b/build/docs/KnowledgeSuggestionConfig.md
new file mode 100644
index 000000000..2136bc560
--- /dev/null
+++ b/build/docs/KnowledgeSuggestionConfig.md
@@ -0,0 +1,15 @@
+---
+title: KnowledgeSuggestionConfig
+---
+## KnowledgeSuggestionConfig
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **vendor_name** | **str** | The name of vendor used for knowledge suggestions. | |
+| **knowledge_base** | [**KnowledgeBaseReference**](KnowledgeBaseReference.html) | The ID of knowledge base to query when Genesys is the knowledge suggestions provider. | [optional] |
+| **knowledge_bases** | [**list[KnowledgeBaseWithDialectReference]**](KnowledgeBaseWithDialectReference.html) | The knowledge bases to query based on dialect, when Genesys is the knowledge suggestions provider. | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/LanguageEntityListing.md b/build/docs/LanguageEntityListing.md
index 234ab5350..81b75ca05 100644
--- a/build/docs/LanguageEntityListing.md
+++ b/build/docs/LanguageEntityListing.md
@@ -11,8 +11,8 @@ title: LanguageEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/LearningAssignmentUserListing.md b/build/docs/LearningAssignmentUserListing.md
index 05890dac5..87c94a805 100644
--- a/build/docs/LearningAssignmentUserListing.md
+++ b/build/docs/LearningAssignmentUserListing.md
@@ -12,8 +12,8 @@ title: LearningAssignmentUserListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | The number of users matching search term | [optional] |
| **unfiltered_total** | **int** | The total number of users | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/LearningAssignmentsDomainEntity.md b/build/docs/LearningAssignmentsDomainEntity.md
index bbb25bc0a..ce4072e62 100644
--- a/build/docs/LearningAssignmentsDomainEntity.md
+++ b/build/docs/LearningAssignmentsDomainEntity.md
@@ -11,8 +11,8 @@ title: LearningAssignmentsDomainEntity
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/LearningModulesDomainEntityListing.md b/build/docs/LearningModulesDomainEntityListing.md
index c48183c81..46ac3aa30 100644
--- a/build/docs/LearningModulesDomainEntityListing.md
+++ b/build/docs/LearningModulesDomainEntityListing.md
@@ -11,8 +11,8 @@ title: LearningModulesDomainEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/LexBotAliasEntityListing.md b/build/docs/LexBotAliasEntityListing.md
index 87d1e199c..7b00de9cb 100644
--- a/build/docs/LexBotAliasEntityListing.md
+++ b/build/docs/LexBotAliasEntityListing.md
@@ -11,8 +11,8 @@ title: LexBotAliasEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/LexBotEntityListing.md b/build/docs/LexBotEntityListing.md
index c9412f533..e971451a6 100644
--- a/build/docs/LexBotEntityListing.md
+++ b/build/docs/LexBotEntityListing.md
@@ -11,8 +11,8 @@ title: LexBotEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/LexV2BotAliasEntityListing.md b/build/docs/LexV2BotAliasEntityListing.md
index 830c90487..12cdb3ec5 100644
--- a/build/docs/LexV2BotAliasEntityListing.md
+++ b/build/docs/LexV2BotAliasEntityListing.md
@@ -11,8 +11,8 @@ title: LexV2BotAliasEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/LexV2BotEntityListing.md b/build/docs/LexV2BotEntityListing.md
index 359d08398..bdfe5e85b 100644
--- a/build/docs/LexV2BotEntityListing.md
+++ b/build/docs/LexV2BotEntityListing.md
@@ -11,8 +11,8 @@ title: LexV2BotEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/LibraryEntityListing.md b/build/docs/LibraryEntityListing.md
index 5375174a5..9a172644e 100644
--- a/build/docs/LibraryEntityListing.md
+++ b/build/docs/LibraryEntityListing.md
@@ -11,8 +11,8 @@ title: LibraryEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/LineBaseEntityListing.md b/build/docs/LineBaseEntityListing.md
index 84ba96951..98c217a5f 100644
--- a/build/docs/LineBaseEntityListing.md
+++ b/build/docs/LineBaseEntityListing.md
@@ -12,8 +12,8 @@ title: LineBaseEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/LineEntityListing.md b/build/docs/LineEntityListing.md
index a80b7fbea..fb89c67de 100644
--- a/build/docs/LineEntityListing.md
+++ b/build/docs/LineEntityListing.md
@@ -12,8 +12,8 @@ title: LineEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/LocationEntityListing.md b/build/docs/LocationEntityListing.md
index 723ac61c5..ddf7fb413 100644
--- a/build/docs/LocationEntityListing.md
+++ b/build/docs/LocationEntityListing.md
@@ -11,8 +11,8 @@ title: LocationEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/LogicalInterfaceEntityListing.md b/build/docs/LogicalInterfaceEntityListing.md
index a3076858b..74eb6a25d 100644
--- a/build/docs/LogicalInterfaceEntityListing.md
+++ b/build/docs/LogicalInterfaceEntityListing.md
@@ -11,8 +11,8 @@ title: LogicalInterfaceEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ManagementUnitListing.md b/build/docs/ManagementUnitListing.md
index a99298090..d437e5e59 100644
--- a/build/docs/ManagementUnitListing.md
+++ b/build/docs/ManagementUnitListing.md
@@ -11,8 +11,8 @@ title: ManagementUnitListing
| **page_size** | **int** | Deprecated, paging is not supported | [optional] |
| **page_number** | **int** | Deprecated, paging is not supported | [optional] |
| **total** | **int** | Deprecated, paging is not supported | [optional] |
-| **last_uri** | **str** | Deprecated, paging is not supported | [optional] |
| **first_uri** | **str** | Deprecated, paging is not supported | [optional] |
+| **last_uri** | **str** | Deprecated, paging is not supported | [optional] |
| **next_uri** | **str** | Deprecated, paging is not supported | [optional] |
| **page_count** | **int** | Deprecated, paging is not supported | [optional] |
| **previous_uri** | **str** | Deprecated, paging is not supported | [optional] |
diff --git a/build/docs/MessageConversationEntityListing.md b/build/docs/MessageConversationEntityListing.md
index f6ebde546..fc62c46a8 100644
--- a/build/docs/MessageConversationEntityListing.md
+++ b/build/docs/MessageConversationEntityListing.md
@@ -11,8 +11,8 @@ title: MessageConversationEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/MessagingCampaignDivisionViewEntityListing.md b/build/docs/MessagingCampaignDivisionViewEntityListing.md
index 928ec43e2..37baac92e 100644
--- a/build/docs/MessagingCampaignDivisionViewEntityListing.md
+++ b/build/docs/MessagingCampaignDivisionViewEntityListing.md
@@ -11,8 +11,8 @@ title: MessagingCampaignDivisionViewEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/MessagingCampaignEntityListing.md b/build/docs/MessagingCampaignEntityListing.md
index 4f744c60c..15407aaf0 100644
--- a/build/docs/MessagingCampaignEntityListing.md
+++ b/build/docs/MessagingCampaignEntityListing.md
@@ -11,8 +11,8 @@ title: MessagingCampaignEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/MessagingCampaignScheduleEntityListing.md b/build/docs/MessagingCampaignScheduleEntityListing.md
index 3ca73113a..8d849653e 100644
--- a/build/docs/MessagingCampaignScheduleEntityListing.md
+++ b/build/docs/MessagingCampaignScheduleEntityListing.md
@@ -11,8 +11,8 @@ title: MessagingCampaignScheduleEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/MessagingConfigListing.md b/build/docs/MessagingConfigListing.md
index 727ebf7fb..8c541c20d 100644
--- a/build/docs/MessagingConfigListing.md
+++ b/build/docs/MessagingConfigListing.md
@@ -11,8 +11,8 @@ title: MessagingConfigListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/MessagingIntegrationEntityListing.md b/build/docs/MessagingIntegrationEntityListing.md
index ba61b32e4..975f49e1a 100644
--- a/build/docs/MessagingIntegrationEntityListing.md
+++ b/build/docs/MessagingIntegrationEntityListing.md
@@ -11,8 +11,8 @@ title: MessagingIntegrationEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/NluConfig.md b/build/docs/NluConfig.md
new file mode 100644
index 000000000..c9c34b58a
--- /dev/null
+++ b/build/docs/NluConfig.md
@@ -0,0 +1,14 @@
+---
+title: NluConfig
+---
+## NluConfig
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **domain** | [**CopilotNluDomain**](CopilotNluDomain.html) | NLU domain. | |
+| **intent_confidence_threshold** | **float** | Minimum confidence value of accepting NLU intents, must be greater than 0 and less than 1. | |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/NluDomainListing.md b/build/docs/NluDomainListing.md
index 66fc7dd0f..309801240 100644
--- a/build/docs/NluDomainListing.md
+++ b/build/docs/NluDomainListing.md
@@ -11,8 +11,8 @@ title: NluDomainListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/NluDomainVersionListing.md b/build/docs/NluDomainVersionListing.md
index bc0148d69..1d7d48d41 100644
--- a/build/docs/NluDomainVersionListing.md
+++ b/build/docs/NluDomainVersionListing.md
@@ -11,8 +11,8 @@ title: NluDomainVersionListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/NluFeedbackListing.md b/build/docs/NluFeedbackListing.md
index 47c7e65cb..3902f15e8 100644
--- a/build/docs/NluFeedbackListing.md
+++ b/build/docs/NluFeedbackListing.md
@@ -11,8 +11,8 @@ title: NluFeedbackListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/NoteListing.md b/build/docs/NoteListing.md
index d83e2d44a..97e1daefb 100644
--- a/build/docs/NoteListing.md
+++ b/build/docs/NoteListing.md
@@ -12,8 +12,8 @@ title: NoteListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **partial_results** | **bool** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/NuanceBotEntityListing.md b/build/docs/NuanceBotEntityListing.md
index 94fbb5734..ff04b77f4 100644
--- a/build/docs/NuanceBotEntityListing.md
+++ b/build/docs/NuanceBotEntityListing.md
@@ -11,8 +11,8 @@ title: NuanceBotEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/OAuthClientEntityListing.md b/build/docs/OAuthClientEntityListing.md
index a07c2170d..0dce8c35f 100644
--- a/build/docs/OAuthClientEntityListing.md
+++ b/build/docs/OAuthClientEntityListing.md
@@ -11,8 +11,8 @@ title: OAuthClientEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/OpenIntegrationEntityListing.md b/build/docs/OpenIntegrationEntityListing.md
index e0f1e4972..373ef58a6 100644
--- a/build/docs/OpenIntegrationEntityListing.md
+++ b/build/docs/OpenIntegrationEntityListing.md
@@ -11,8 +11,8 @@ title: OpenIntegrationEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/OrganizationPresenceEntityListing.md b/build/docs/OrganizationPresenceEntityListing.md
index 00b3bbc8b..b5185eed6 100644
--- a/build/docs/OrganizationPresenceEntityListing.md
+++ b/build/docs/OrganizationPresenceEntityListing.md
@@ -11,8 +11,8 @@ title: OrganizationPresenceEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/OrganizationRoleEntityListing.md b/build/docs/OrganizationRoleEntityListing.md
index 4eac8841a..c27f89c06 100644
--- a/build/docs/OrganizationRoleEntityListing.md
+++ b/build/docs/OrganizationRoleEntityListing.md
@@ -11,8 +11,8 @@ title: OrganizationRoleEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/OrphanRecordingListing.md b/build/docs/OrphanRecordingListing.md
index 0bd102f31..6b14b21e7 100644
--- a/build/docs/OrphanRecordingListing.md
+++ b/build/docs/OrphanRecordingListing.md
@@ -11,8 +11,8 @@ title: OrphanRecordingListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/OutboundDomainEntityListing.md b/build/docs/OutboundDomainEntityListing.md
index 31e6f9ac6..040cadb61 100644
--- a/build/docs/OutboundDomainEntityListing.md
+++ b/build/docs/OutboundDomainEntityListing.md
@@ -11,8 +11,8 @@ title: OutboundDomainEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/OutboundRouteBaseEntityListing.md b/build/docs/OutboundRouteBaseEntityListing.md
index 9a32f9f45..131384d46 100644
--- a/build/docs/OutboundRouteBaseEntityListing.md
+++ b/build/docs/OutboundRouteBaseEntityListing.md
@@ -12,8 +12,8 @@ title: OutboundRouteBaseEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/OutboundRouteEntityListing.md b/build/docs/OutboundRouteEntityListing.md
index 015ca85dc..173b77927 100644
--- a/build/docs/OutboundRouteEntityListing.md
+++ b/build/docs/OutboundRouteEntityListing.md
@@ -12,8 +12,8 @@ title: OutboundRouteEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/OutcomeListing.md b/build/docs/OutcomeListing.md
index bd0934338..a60139952 100644
--- a/build/docs/OutcomeListing.md
+++ b/build/docs/OutcomeListing.md
@@ -11,8 +11,8 @@ title: OutcomeListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/PermissionCollectionEntityListing.md b/build/docs/PermissionCollectionEntityListing.md
index c33b9b1a8..e446ea282 100644
--- a/build/docs/PermissionCollectionEntityListing.md
+++ b/build/docs/PermissionCollectionEntityListing.md
@@ -11,8 +11,8 @@ title: PermissionCollectionEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/PhoneBaseEntityListing.md b/build/docs/PhoneBaseEntityListing.md
index 420d732a1..a4787484e 100644
--- a/build/docs/PhoneBaseEntityListing.md
+++ b/build/docs/PhoneBaseEntityListing.md
@@ -12,8 +12,8 @@ title: PhoneBaseEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/PhoneEntityListing.md b/build/docs/PhoneEntityListing.md
index c437cc0a1..01f328f89 100644
--- a/build/docs/PhoneEntityListing.md
+++ b/build/docs/PhoneEntityListing.md
@@ -12,8 +12,8 @@ title: PhoneEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/PhoneMetaBaseEntityListing.md b/build/docs/PhoneMetaBaseEntityListing.md
index 0c2f62ff6..0c432ce29 100644
--- a/build/docs/PhoneMetaBaseEntityListing.md
+++ b/build/docs/PhoneMetaBaseEntityListing.md
@@ -12,8 +12,8 @@ title: PhoneMetaBaseEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/PhysicalInterfaceEntityListing.md b/build/docs/PhysicalInterfaceEntityListing.md
index 9abadbdd4..1caccf0ad 100644
--- a/build/docs/PhysicalInterfaceEntityListing.md
+++ b/build/docs/PhysicalInterfaceEntityListing.md
@@ -11,8 +11,8 @@ title: PhysicalInterfaceEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/PolicyEntityListing.md b/build/docs/PolicyEntityListing.md
index ade34d17c..27d408abc 100644
--- a/build/docs/PolicyEntityListing.md
+++ b/build/docs/PolicyEntityListing.md
@@ -11,8 +11,8 @@ title: PolicyEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/PromptAssetEntityListing.md b/build/docs/PromptAssetEntityListing.md
index 2d56d5b6b..6a15bdaca 100644
--- a/build/docs/PromptAssetEntityListing.md
+++ b/build/docs/PromptAssetEntityListing.md
@@ -11,8 +11,8 @@ title: PromptAssetEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/PromptEntityListing.md b/build/docs/PromptEntityListing.md
index 3583f7cef..677e5cb76 100644
--- a/build/docs/PromptEntityListing.md
+++ b/build/docs/PromptEntityListing.md
@@ -11,8 +11,8 @@ title: PromptEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/QueueEntityListing.md b/build/docs/QueueEntityListing.md
index 437845691..74f6ddcfd 100644
--- a/build/docs/QueueEntityListing.md
+++ b/build/docs/QueueEntityListing.md
@@ -11,8 +11,8 @@ title: QueueEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/QueueMemberEntityListingV1.md b/build/docs/QueueMemberEntityListingV1.md
index 378728e91..483bbaf99 100644
--- a/build/docs/QueueMemberEntityListingV1.md
+++ b/build/docs/QueueMemberEntityListingV1.md
@@ -11,8 +11,8 @@ title: QueueMemberEntityListingV1
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/RecipientListing.md b/build/docs/RecipientListing.md
index 85e0abfff..c512621f0 100644
--- a/build/docs/RecipientListing.md
+++ b/build/docs/RecipientListing.md
@@ -11,8 +11,8 @@ title: RecipientListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/RecordingJobEntityListing.md b/build/docs/RecordingJobEntityListing.md
index 04efbc5a9..f3b989c0a 100644
--- a/build/docs/RecordingJobEntityListing.md
+++ b/build/docs/RecordingJobEntityListing.md
@@ -11,8 +11,8 @@ title: RecordingJobEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/RelationshipListing.md b/build/docs/RelationshipListing.md
index 2555f46af..9debe95dc 100644
--- a/build/docs/RelationshipListing.md
+++ b/build/docs/RelationshipListing.md
@@ -12,8 +12,8 @@ title: RelationshipListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **partial_results** | **bool** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ReportingExportJobListing.md b/build/docs/ReportingExportJobListing.md
index 7d94d9c0a..bdc1d8d4e 100644
--- a/build/docs/ReportingExportJobListing.md
+++ b/build/docs/ReportingExportJobListing.md
@@ -11,8 +11,8 @@ title: ReportingExportJobListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ReportingExportMetadataJobListing.md b/build/docs/ReportingExportMetadataJobListing.md
index eebf44d2d..c70936589 100644
--- a/build/docs/ReportingExportMetadataJobListing.md
+++ b/build/docs/ReportingExportMetadataJobListing.md
@@ -11,8 +11,8 @@ title: ReportingExportMetadataJobListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ResponseEntityList.md b/build/docs/ResponseEntityList.md
index 0091815bc..d26ac71b0 100644
--- a/build/docs/ResponseEntityList.md
+++ b/build/docs/ResponseEntityList.md
@@ -11,8 +11,8 @@ title: ResponseEntityList
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ResponseEntityListing.md b/build/docs/ResponseEntityListing.md
index 4a01cb15c..9176fae55 100644
--- a/build/docs/ResponseEntityListing.md
+++ b/build/docs/ResponseEntityListing.md
@@ -11,8 +11,8 @@ title: ResponseEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ResponseSetEntityListing.md b/build/docs/ResponseSetEntityListing.md
index 33aec1498..31e4e25ef 100644
--- a/build/docs/ResponseSetEntityListing.md
+++ b/build/docs/ResponseSetEntityListing.md
@@ -11,8 +11,8 @@ title: ResponseSetEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ResponseText.md b/build/docs/ResponseText.md
index 5f84d6bc2..327c84ada 100644
--- a/build/docs/ResponseText.md
+++ b/build/docs/ResponseText.md
@@ -9,6 +9,7 @@ title: ResponseText
|------------ | ------------- | ------------- | -------------|
| **content** | **str** | Response text content. | |
| **content_type** | **str** | Response text content type. | [optional] |
+| **type** | **str** | Response text type. | [optional] |
{: class="table table-striped"}
diff --git a/build/docs/RoutingApi.md b/build/docs/RoutingApi.md
index f15ef8205..ecd82655a 100644
--- a/build/docs/RoutingApi.md
+++ b/build/docs/RoutingApi.md
@@ -57,6 +57,7 @@ All URIs are relative to *https://api.mypurecloud.com*
|[**get_routing_predictors**](RoutingApi.html#get_routing_predictors) | Retrieve all predictors.|
|[**get_routing_predictors_keyperformanceindicators**](RoutingApi.html#get_routing_predictors_keyperformanceindicators) | Get a list of Key Performance Indicators|
|[**get_routing_queue**](RoutingApi.html#get_routing_queue) | Get details about this queue.|
+|[**get_routing_queue_assistant**](RoutingApi.html#get_routing_queue_assistant) | Get an assistant associated with a queue.|
|[**get_routing_queue_comparisonperiod**](RoutingApi.html#get_routing_queue_comparisonperiod) | Get a Comparison Period.|
|[**get_routing_queue_comparisonperiods**](RoutingApi.html#get_routing_queue_comparisonperiods) | Get list of comparison periods|
|[**get_routing_queue_estimatedwaittime**](RoutingApi.html#get_routing_queue_estimatedwaittime) | Get Estimated Wait Time|
@@ -2583,6 +2584,57 @@ except ApiException as e:
[**Queue**](Queue.html)
+
+
+## [**AssistantQueue**](AssistantQueue.html) get_routing_queue_assistant(queue_id, expand=expand)
+
+
+
+Get an assistant associated with a queue.
+
+Wraps GET /api/v2/routing/queues/{queueId}/assistant
+
+Requires ALL permissions:
+
+* assistants:queue:view
+
+### Example
+
+```{"language":"python"}
+import time
+import PureCloudPlatformClientV2
+from PureCloudPlatformClientV2.rest import ApiException
+from pprint import pprint
+
+# Configure OAuth2 access token for authorization: PureCloud OAuth
+PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
+
+# create an instance of the API class
+api_instance = PureCloudPlatformClientV2.RoutingApi()
+queue_id = 'queue_id_example' # str | Queue ID
+expand = 'expand_example' # str | Which fields, if any, to expand. (optional)
+
+try:
+ # Get an assistant associated with a queue.
+ api_response = api_instance.get_routing_queue_assistant(queue_id, expand=expand)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling RoutingApi->get_routing_queue_assistant: %s\n" % e)
+```
+
+### Parameters
+
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **queue_id** | **str**| Queue ID | |
+| **expand** | **str**| Which fields, if any, to expand. | [optional]
**Values**: assistant |
+{: class="table table-striped"}
+
+### Return type
+
+[**AssistantQueue**](AssistantQueue.html)
+
## [**ComparisonPeriod**](ComparisonPeriod.html) get_routing_queue_comparisonperiod(queue_id, comparison_period_id)
diff --git a/build/docs/RoutingConversationAttributesRequest.md b/build/docs/RoutingConversationAttributesRequest.md
index cde14696b..fd964de7c 100644
--- a/build/docs/RoutingConversationAttributesRequest.md
+++ b/build/docs/RoutingConversationAttributesRequest.md
@@ -10,6 +10,7 @@ title: RoutingConversationAttributesRequest
| **priority** | **int** | Priority for the conversation. Each point of priority is equivalent to one minute of time in queue. Range:[-25000000, 25000000]. To reset, specify 0. | [optional] |
| **skill_ids** | **list[str]** | Skill requirements for the conversation. To remove all skill requirements, specify an empty list, i.e. []. | [optional] |
| **language_id** | **str** | Language requirement for the conversation. To remove the language requirement, specify an empty string, i.e., \"\". | [optional] |
+| **label_id** | **str** | Label requirement for the conversation. To remove the label requirement (setting it to System Default Label), specify an empty string, i.e., \"\". | [optional] |
| **request_scored_agents** | [**list[RequestScoredAgent]**](RequestScoredAgent.html) | | [optional] |
{: class="table table-striped"}
diff --git a/build/docs/RoutingConversationAttributesResponse.md b/build/docs/RoutingConversationAttributesResponse.md
index 191565543..a42fae418 100644
--- a/build/docs/RoutingConversationAttributesResponse.md
+++ b/build/docs/RoutingConversationAttributesResponse.md
@@ -10,6 +10,7 @@ title: RoutingConversationAttributesResponse
| **priority** | **int** | Current priority value on in-queue conversation. Range:[-25000000, 25000000] | [optional] |
| **skills** | [**list[RoutingSkill]**](RoutingSkill.html) | Current routing skills on in-queue conversation | [optional] |
| **language** | [**Language**](Language.html) | Current language on in-queue conversation | [optional] |
+| **label** | [**UtilizationLabel**](UtilizationLabel.html) | Current label on in-queue conversation | [optional] |
| **scored_agents** | [**list[ScoredAgent]**](ScoredAgent.html) | Current scored agents on in-queue conversation | [optional] |
{: class="table table-striped"}
diff --git a/build/docs/RuleConfig.md b/build/docs/RuleConfig.md
new file mode 100644
index 000000000..905615315
--- /dev/null
+++ b/build/docs/RuleConfig.md
@@ -0,0 +1,15 @@
+---
+title: RuleConfig
+---
+## RuleConfig
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **str** | Rule ID. | [optional] |
+| **enabled** | **bool** | Rule enabled. | |
+| **rule** | [**CopilotRule**](CopilotRule.html) | Rule configuration. | |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/RuleEngineConfig.md b/build/docs/RuleEngineConfig.md
new file mode 100644
index 000000000..94d5085a7
--- /dev/null
+++ b/build/docs/RuleEngineConfig.md
@@ -0,0 +1,14 @@
+---
+title: RuleEngineConfig
+---
+## RuleEngineConfig
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **rules** | [**list[RuleConfig]**](RuleConfig.html) | List of rules to evaluate by the engine. | |
+| **fallback** | [**Fallback**](Fallback.html) | Fallback configuration. | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/RuleSetEntityListing.md b/build/docs/RuleSetEntityListing.md
index 1a4b77638..6d874aef5 100644
--- a/build/docs/RuleSetEntityListing.md
+++ b/build/docs/RuleSetEntityListing.md
@@ -11,8 +11,8 @@ title: RuleSetEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ScheduleDivisionViewEntityListing.md b/build/docs/ScheduleDivisionViewEntityListing.md
index 6f0b1d12d..b98a85624 100644
--- a/build/docs/ScheduleDivisionViewEntityListing.md
+++ b/build/docs/ScheduleDivisionViewEntityListing.md
@@ -12,8 +12,8 @@ title: ScheduleDivisionViewEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ScheduleEntityListing.md b/build/docs/ScheduleEntityListing.md
index 4ea91a020..255caf6b4 100644
--- a/build/docs/ScheduleEntityListing.md
+++ b/build/docs/ScheduleEntityListing.md
@@ -12,8 +12,8 @@ title: ScheduleEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ScheduleGroupDivisionViewEntityListing.md b/build/docs/ScheduleGroupDivisionViewEntityListing.md
index ea561c99e..bd05125a5 100644
--- a/build/docs/ScheduleGroupDivisionViewEntityListing.md
+++ b/build/docs/ScheduleGroupDivisionViewEntityListing.md
@@ -12,8 +12,8 @@ title: ScheduleGroupDivisionViewEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ScheduleGroupEntityListing.md b/build/docs/ScheduleGroupEntityListing.md
index a9bc0db61..50d701ae2 100644
--- a/build/docs/ScheduleGroupEntityListing.md
+++ b/build/docs/ScheduleGroupEntityListing.md
@@ -12,8 +12,8 @@ title: ScheduleGroupEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ScreenRecordingSessionListing.md b/build/docs/ScreenRecordingSessionListing.md
index 678b0946e..c8f16cd45 100644
--- a/build/docs/ScreenRecordingSessionListing.md
+++ b/build/docs/ScreenRecordingSessionListing.md
@@ -11,8 +11,8 @@ title: ScreenRecordingSessionListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/ScriptEntityListing.md b/build/docs/ScriptEntityListing.md
index 593430c94..33f1a185a 100644
--- a/build/docs/ScriptEntityListing.md
+++ b/build/docs/ScriptEntityListing.md
@@ -11,8 +11,8 @@ title: ScriptEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/SecurityProfileEntityListing.md b/build/docs/SecurityProfileEntityListing.md
index da84a54a2..5c33ef41b 100644
--- a/build/docs/SecurityProfileEntityListing.md
+++ b/build/docs/SecurityProfileEntityListing.md
@@ -11,8 +11,8 @@ title: SecurityProfileEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/SegmentListing.md b/build/docs/SegmentListing.md
index c9acc64d4..9c7ce0141 100644
--- a/build/docs/SegmentListing.md
+++ b/build/docs/SegmentListing.md
@@ -11,8 +11,8 @@ title: SegmentListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/SettingsApi.md b/build/docs/SettingsApi.md
index 6ac192f17..a75fe384c 100644
--- a/build/docs/SettingsApi.md
+++ b/build/docs/SettingsApi.md
@@ -121,8 +121,6 @@ Get the execution history enabled setting.
Get the execution history enabled setting.
-get_settings_executiondata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
-
Wraps GET /api/v2/settings/executiondata
Requires ANY permissions:
@@ -268,8 +266,6 @@ Edit the execution history on off setting.
Edit the execution history on off setting.
-patch_settings_executiondata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
-
Wraps PATCH /api/v2/settings/executiondata
Requires ANY permissions:
diff --git a/build/docs/ShareEntityListing.md b/build/docs/ShareEntityListing.md
index 52b99f718..3412292aa 100644
--- a/build/docs/ShareEntityListing.md
+++ b/build/docs/ShareEntityListing.md
@@ -11,8 +11,8 @@ title: ShareEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/SiteEntityListing.md b/build/docs/SiteEntityListing.md
index 5eb7c7a33..76ad21f77 100644
--- a/build/docs/SiteEntityListing.md
+++ b/build/docs/SiteEntityListing.md
@@ -12,8 +12,8 @@ title: SiteEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/SkillEntityListing.md b/build/docs/SkillEntityListing.md
index 37302e3f5..38bf4e14f 100644
--- a/build/docs/SkillEntityListing.md
+++ b/build/docs/SkillEntityListing.md
@@ -11,8 +11,8 @@ title: SkillEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/SmsAddressEntityListing.md b/build/docs/SmsAddressEntityListing.md
index 03b5d5f5e..910ab2f65 100644
--- a/build/docs/SmsAddressEntityListing.md
+++ b/build/docs/SmsAddressEntityListing.md
@@ -11,8 +11,8 @@ title: SmsAddressEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/SmsPhoneNumberEntityListing.md b/build/docs/SmsPhoneNumberEntityListing.md
index 77de7033e..8b111de90 100644
--- a/build/docs/SmsPhoneNumberEntityListing.md
+++ b/build/docs/SmsPhoneNumberEntityListing.md
@@ -11,8 +11,8 @@ title: SmsPhoneNumberEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/StationEntityListing.md b/build/docs/StationEntityListing.md
index 8f1995b2e..41946304d 100644
--- a/build/docs/StationEntityListing.md
+++ b/build/docs/StationEntityListing.md
@@ -12,8 +12,8 @@ title: StationEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/SttEngineEntityListing.md b/build/docs/SttEngineEntityListing.md
index 20d38f17e..0fde3af16 100644
--- a/build/docs/SttEngineEntityListing.md
+++ b/build/docs/SttEngineEntityListing.md
@@ -11,8 +11,8 @@ title: SttEngineEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/SubjectDivisionGrantsEntityListing.md b/build/docs/SubjectDivisionGrantsEntityListing.md
index 119b7ce80..e8c413855 100644
--- a/build/docs/SubjectDivisionGrantsEntityListing.md
+++ b/build/docs/SubjectDivisionGrantsEntityListing.md
@@ -11,8 +11,8 @@ title: SubjectDivisionGrantsEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/SummaryGenerationConfig.md b/build/docs/SummaryGenerationConfig.md
new file mode 100644
index 000000000..b3e3fbd06
--- /dev/null
+++ b/build/docs/SummaryGenerationConfig.md
@@ -0,0 +1,13 @@
+---
+title: SummaryGenerationConfig
+---
+## SummaryGenerationConfig
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **enabled** | **bool** | Copilot generated summary is enabled. | |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/SupportedContentListing.md b/build/docs/SupportedContentListing.md
index 04536a396..3ad0b590e 100644
--- a/build/docs/SupportedContentListing.md
+++ b/build/docs/SupportedContentListing.md
@@ -11,8 +11,8 @@ title: SupportedContentListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/SurveyFormEntityListing.md b/build/docs/SurveyFormEntityListing.md
index 172266d24..c44117fd8 100644
--- a/build/docs/SurveyFormEntityListing.md
+++ b/build/docs/SurveyFormEntityListing.md
@@ -11,8 +11,8 @@ title: SurveyFormEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/SystemPromptAssetEntityListing.md b/build/docs/SystemPromptAssetEntityListing.md
index 168d6e0cb..bfa5e6868 100644
--- a/build/docs/SystemPromptAssetEntityListing.md
+++ b/build/docs/SystemPromptAssetEntityListing.md
@@ -11,8 +11,8 @@ title: SystemPromptAssetEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/SystemPromptEntityListing.md b/build/docs/SystemPromptEntityListing.md
index fea2ab078..5c154e69f 100644
--- a/build/docs/SystemPromptEntityListing.md
+++ b/build/docs/SystemPromptEntityListing.md
@@ -11,8 +11,8 @@ title: SystemPromptEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/TagValueEntityListing.md b/build/docs/TagValueEntityListing.md
index f6f99b571..6754465af 100644
--- a/build/docs/TagValueEntityListing.md
+++ b/build/docs/TagValueEntityListing.md
@@ -11,8 +11,8 @@ title: TagValueEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/TaskManagementApi.md b/build/docs/TaskManagementApi.md
index b3575bc38..65492ef09 100644
--- a/build/docs/TaskManagementApi.md
+++ b/build/docs/TaskManagementApi.md
@@ -1185,7 +1185,7 @@ except ApiException as e:
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **worktype_id** | **str**| Worktype id | |
-| **expands** | [**list[str]**](str.html)| Which fields, if any, to expand. | [optional]
**Values**: defaultQueue, defaultSkills, defaultLanguage, schema |
+| **expands** | [**list[str]**](str.html)| Which fields, if any, to expand. | [optional]
**Values**: defaultQueue, defaultSkills, defaultLanguage, schema, flow |
{: class="table table-striped"}
### Return type
diff --git a/build/docs/TimeZoneEntityListing.md b/build/docs/TimeZoneEntityListing.md
index 5bb528e91..c1693bdb8 100644
--- a/build/docs/TimeZoneEntityListing.md
+++ b/build/docs/TimeZoneEntityListing.md
@@ -11,8 +11,8 @@ title: TimeZoneEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/TranscriptionConfig.md b/build/docs/TranscriptionConfig.md
new file mode 100644
index 000000000..b8dd7a42c
--- /dev/null
+++ b/build/docs/TranscriptionConfig.md
@@ -0,0 +1,13 @@
+---
+title: TranscriptionConfig
+---
+## TranscriptionConfig
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **vendor_name** | **str** | The name of the vendor used for speech transcription. | |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/TransferRequest.md b/build/docs/TransferRequest.md
index 0bf8d7b45..855ca538e 100644
--- a/build/docs/TransferRequest.md
+++ b/build/docs/TransferRequest.md
@@ -8,6 +8,7 @@ title: TransferRequest
|Name | Type | Description | Notes|
|------------ | ------------- | ------------- | -------------|
| **transfer_type** | **str** | 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. | [optional] |
+| **keep_internal_message_alive** | **bool** | If true, the digital internal message will NOT be terminated. | [optional] |
| **user_id** | **str** | The user ID of the transfer target. | [optional] |
| **address** | **str** | 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. | [optional] |
| **user_name** | **str** | The user name of the transfer target. | [optional] |
diff --git a/build/docs/TransferToAgentRequest.md b/build/docs/TransferToAgentRequest.md
index d53eedbc5..57d211079 100644
--- a/build/docs/TransferToAgentRequest.md
+++ b/build/docs/TransferToAgentRequest.md
@@ -8,6 +8,7 @@ title: TransferToAgentRequest
|Name | Type | Description | Notes|
|------------ | ------------- | ------------- | -------------|
| **transfer_type** | **str** | 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. | [optional] |
+| **keep_internal_message_alive** | **bool** | If true, the digital internal message will NOT be terminated. | [optional] |
| **user_id** | **str** | The id of the internal user. | [optional] |
| **user_name** | **str** | The userName (like user’s email) of the internal user. | [optional] |
| **user_display_name** | **str** | The name of the internal user. | [optional] |
diff --git a/build/docs/TransferToExternalRequest.md b/build/docs/TransferToExternalRequest.md
index c0980bd4f..d196bfe03 100644
--- a/build/docs/TransferToExternalRequest.md
+++ b/build/docs/TransferToExternalRequest.md
@@ -8,6 +8,7 @@ title: TransferToExternalRequest
|Name | Type | Description | Notes|
|------------ | ------------- | ------------- | -------------|
| **transfer_type** | **str** | 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. | [optional] |
+| **keep_internal_message_alive** | **bool** | If true, the digital internal message will NOT be terminated. | [optional] |
| **address** | **str** | The address (like phone number) of the external contact. | [optional] |
{: class="table table-striped"}
diff --git a/build/docs/TransferToQueueRequest.md b/build/docs/TransferToQueueRequest.md
index 3ad8fd2d0..bc708a0a8 100644
--- a/build/docs/TransferToQueueRequest.md
+++ b/build/docs/TransferToQueueRequest.md
@@ -8,6 +8,7 @@ title: TransferToQueueRequest
|Name | Type | Description | Notes|
|------------ | ------------- | ------------- | -------------|
| **transfer_type** | **str** | 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. | [optional] |
+| **keep_internal_message_alive** | **bool** | If true, the digital internal message will NOT be terminated. | [optional] |
| **queue_id** | **str** | The id of the queue. | [optional] |
| **queue_name** | **str** | The name of the queue. | [optional] |
{: class="table table-striped"}
diff --git a/build/docs/TrunkBaseEntityListing.md b/build/docs/TrunkBaseEntityListing.md
index dfed2d69c..65677b119 100644
--- a/build/docs/TrunkBaseEntityListing.md
+++ b/build/docs/TrunkBaseEntityListing.md
@@ -12,8 +12,8 @@ title: TrunkBaseEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/TrunkEntityListing.md b/build/docs/TrunkEntityListing.md
index f657549b8..c291a50c0 100644
--- a/build/docs/TrunkEntityListing.md
+++ b/build/docs/TrunkEntityListing.md
@@ -12,8 +12,8 @@ title: TrunkEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/TrunkMetabaseEntityListing.md b/build/docs/TrunkMetabaseEntityListing.md
index d74dc9e24..05c4634d7 100644
--- a/build/docs/TrunkMetabaseEntityListing.md
+++ b/build/docs/TrunkMetabaseEntityListing.md
@@ -12,8 +12,8 @@ title: TrunkMetabaseEntityListing
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
| **total_number_of_entities** | **int** | The total organization-wide number of entities. | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/TrustEntityListing.md b/build/docs/TrustEntityListing.md
index 0fa514073..989afbbcc 100644
--- a/build/docs/TrustEntityListing.md
+++ b/build/docs/TrustEntityListing.md
@@ -11,8 +11,8 @@ title: TrustEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/TrustGroupEntityListing.md b/build/docs/TrustGroupEntityListing.md
index e0173de98..6997d53ff 100644
--- a/build/docs/TrustGroupEntityListing.md
+++ b/build/docs/TrustGroupEntityListing.md
@@ -11,8 +11,8 @@ title: TrustGroupEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/TrustUserEntityListing.md b/build/docs/TrustUserEntityListing.md
index f68276c6f..11e15187e 100644
--- a/build/docs/TrustUserEntityListing.md
+++ b/build/docs/TrustUserEntityListing.md
@@ -11,8 +11,8 @@ title: TrustUserEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/TrustorEntityListing.md b/build/docs/TrustorEntityListing.md
index ba0a9d092..6212e84b1 100644
--- a/build/docs/TrustorEntityListing.md
+++ b/build/docs/TrustorEntityListing.md
@@ -11,8 +11,8 @@ title: TrustorEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/TtsEngineEntityListing.md b/build/docs/TtsEngineEntityListing.md
index 75f0855fa..1aa693c89 100644
--- a/build/docs/TtsEngineEntityListing.md
+++ b/build/docs/TtsEngineEntityListing.md
@@ -11,8 +11,8 @@ title: TtsEngineEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/TtsVoiceEntityListing.md b/build/docs/TtsVoiceEntityListing.md
index 9c5eef990..2ef4df6ba 100644
--- a/build/docs/TtsVoiceEntityListing.md
+++ b/build/docs/TtsVoiceEntityListing.md
@@ -11,8 +11,8 @@ title: TtsVoiceEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/UCIntegrationListing.md b/build/docs/UCIntegrationListing.md
index 8f193df5b..73faad912 100644
--- a/build/docs/UCIntegrationListing.md
+++ b/build/docs/UCIntegrationListing.md
@@ -11,8 +11,8 @@ title: UCIntegrationListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/UnifiedCommunicationsIntegrationListing.md b/build/docs/UnifiedCommunicationsIntegrationListing.md
index a525d9c66..cecb10ea5 100644
--- a/build/docs/UnifiedCommunicationsIntegrationListing.md
+++ b/build/docs/UnifiedCommunicationsIntegrationListing.md
@@ -11,8 +11,8 @@ title: UnifiedCommunicationsIntegrationListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/UserAppEntityListing.md b/build/docs/UserAppEntityListing.md
index 11f265585..7dc5e1a65 100644
--- a/build/docs/UserAppEntityListing.md
+++ b/build/docs/UserAppEntityListing.md
@@ -11,8 +11,8 @@ title: UserAppEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/UserEntityListing.md b/build/docs/UserEntityListing.md
index 19480d732..bd5b1e56f 100644
--- a/build/docs/UserEntityListing.md
+++ b/build/docs/UserEntityListing.md
@@ -11,8 +11,8 @@ title: UserEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/UserLanguageEntityListing.md b/build/docs/UserLanguageEntityListing.md
index 10d796735..31fae881e 100644
--- a/build/docs/UserLanguageEntityListing.md
+++ b/build/docs/UserLanguageEntityListing.md
@@ -11,8 +11,8 @@ title: UserLanguageEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/UserProfileEntityListing.md b/build/docs/UserProfileEntityListing.md
index bae58ba73..f041a48ef 100644
--- a/build/docs/UserProfileEntityListing.md
+++ b/build/docs/UserProfileEntityListing.md
@@ -11,8 +11,8 @@ title: UserProfileEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/UserQueueEntityListing.md b/build/docs/UserQueueEntityListing.md
index f16d4bffa..3eeaddfd8 100644
--- a/build/docs/UserQueueEntityListing.md
+++ b/build/docs/UserQueueEntityListing.md
@@ -11,8 +11,8 @@ title: UserQueueEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/UserRecordingEntityListing.md b/build/docs/UserRecordingEntityListing.md
index cb573cb59..b3178c65c 100644
--- a/build/docs/UserRecordingEntityListing.md
+++ b/build/docs/UserRecordingEntityListing.md
@@ -11,8 +11,8 @@ title: UserRecordingEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/UserSkillEntityListing.md b/build/docs/UserSkillEntityListing.md
index c2f978eba..b4a63a805 100644
--- a/build/docs/UserSkillEntityListing.md
+++ b/build/docs/UserSkillEntityListing.md
@@ -11,8 +11,8 @@ title: UserSkillEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/UsersApi.md b/build/docs/UsersApi.md
index 19e65b402..2d9c0b8a3 100644
--- a/build/docs/UsersApi.md
+++ b/build/docs/UsersApi.md
@@ -359,6 +359,7 @@ Wraps DELETE /api/v2/users/{userId}
Requires ANY permissions:
+* admin
* directory:user:delete
* directory:organization:admin
@@ -2812,6 +2813,7 @@ Wraps PATCH /api/v2/users/{userId}
Requires ANY permissions:
+* admin
* directory:user:edit
* directory:organization:admin
@@ -3848,6 +3850,7 @@ Wraps POST /api/v2/users/{userId}/invite
Requires ANY permissions:
+* admin
* directory:organization:admin
* directory:userPassword:edit
diff --git a/build/docs/UtilizationLabelEntityListing.md b/build/docs/UtilizationLabelEntityListing.md
index 33a272be1..4e3ae0f2a 100644
--- a/build/docs/UtilizationLabelEntityListing.md
+++ b/build/docs/UtilizationLabelEntityListing.md
@@ -11,8 +11,8 @@ title: UtilizationLabelEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/UtilizationTagEntityListing.md b/build/docs/UtilizationTagEntityListing.md
index d80e9f5fb..e3d901261 100644
--- a/build/docs/UtilizationTagEntityListing.md
+++ b/build/docs/UtilizationTagEntityListing.md
@@ -11,8 +11,8 @@ title: UtilizationTagEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/VoicemailMessageEntityListing.md b/build/docs/VoicemailMessageEntityListing.md
index caa20f35e..e984a1651 100644
--- a/build/docs/VoicemailMessageEntityListing.md
+++ b/build/docs/VoicemailMessageEntityListing.md
@@ -11,8 +11,8 @@ title: VoicemailMessageEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/WebChatMemberInfoEntityList.md b/build/docs/WebChatMemberInfoEntityList.md
index b1c794796..3169e28f4 100644
--- a/build/docs/WebChatMemberInfoEntityList.md
+++ b/build/docs/WebChatMemberInfoEntityList.md
@@ -11,8 +11,8 @@ title: WebChatMemberInfoEntityList
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/WhatsAppIntegrationEntityListing.md b/build/docs/WhatsAppIntegrationEntityListing.md
index 90305fcfc..e51e976f1 100644
--- a/build/docs/WhatsAppIntegrationEntityListing.md
+++ b/build/docs/WhatsAppIntegrationEntityListing.md
@@ -11,8 +11,8 @@ title: WhatsAppIntegrationEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/WorkforceManagementApi.md b/build/docs/WorkforceManagementApi.md
index 8a665d381..bb9ecf38f 100644
--- a/build/docs/WorkforceManagementApi.md
+++ b/build/docs/WorkforceManagementApi.md
@@ -2067,7 +2067,7 @@ except ApiException as e:
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **business_unit_id** | **str**| The ID of the business unit, or 'mine' for the business unit of the logged-in user. | |
-| **expand** | [**list[str]**](str.html)| Include to access additional data on the business unit | [optional]
**Values**: settings, settings.timeZone, settings.startDayOfWeek, settings.shortTermForecasting, settings.scheduling |
+| **expand** | [**list[str]**](str.html)| Include to access additional data on the business unit | [optional]
**Values**: settings, settings.timeZone, settings.startDayOfWeek, settings.shortTermForecasting, settings.scheduling, settings.notifications.scheduling, settings.learning, settings.coaching |
{: class="table table-striped"}
### Return type
diff --git a/build/docs/WorkitemFlowReference.md b/build/docs/WorkitemFlowReference.md
new file mode 100644
index 000000000..0cf428894
--- /dev/null
+++ b/build/docs/WorkitemFlowReference.md
@@ -0,0 +1,15 @@
+---
+title: WorkitemFlowReference
+---
+## WorkitemFlowReference
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **str** | The globally unique identifier for the object. | [optional] |
+| **name** | **str** | | [optional] |
+| **self_uri** | **str** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/WorkitemRuleSettings.md b/build/docs/WorkitemRuleSettings.md
new file mode 100644
index 000000000..f409ec2fd
--- /dev/null
+++ b/build/docs/WorkitemRuleSettings.md
@@ -0,0 +1,12 @@
+---
+title: WorkitemRuleSettings
+---
+## WorkitemRuleSettings
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+{: class="table table-striped"}
+
+
diff --git a/build/docs/WorkspaceEntityListing.md b/build/docs/WorkspaceEntityListing.md
index 7b2041cc9..1cd96fcc7 100644
--- a/build/docs/WorkspaceEntityListing.md
+++ b/build/docs/WorkspaceEntityListing.md
@@ -11,8 +11,8 @@ title: WorkspaceEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/WorkspaceMemberEntityListing.md b/build/docs/WorkspaceMemberEntityListing.md
index fbde9bd9c..c3cffb886 100644
--- a/build/docs/WorkspaceMemberEntityListing.md
+++ b/build/docs/WorkspaceMemberEntityListing.md
@@ -11,8 +11,8 @@ title: WorkspaceMemberEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/WrapupCodeEntityListing.md b/build/docs/WrapupCodeEntityListing.md
index 82be54b7f..79415057e 100644
--- a/build/docs/WrapupCodeEntityListing.md
+++ b/build/docs/WrapupCodeEntityListing.md
@@ -11,8 +11,8 @@ title: WrapupCodeEntityListing
| **page_size** | **int** | | [optional] |
| **page_number** | **int** | | [optional] |
| **total** | **int** | | [optional] |
-| **last_uri** | **str** | | [optional] |
| **first_uri** | **str** | | [optional] |
+| **last_uri** | **str** | | [optional] |
| **self_uri** | **str** | | [optional] |
| **next_uri** | **str** | | [optional] |
| **previous_uri** | **str** | | [optional] |
diff --git a/build/docs/WrapupCodePredictionConfig.md b/build/docs/WrapupCodePredictionConfig.md
new file mode 100644
index 000000000..05ccb3275
--- /dev/null
+++ b/build/docs/WrapupCodePredictionConfig.md
@@ -0,0 +1,13 @@
+---
+title: WrapupCodePredictionConfig
+---
+## WrapupCodePredictionConfig
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **enabled** | **bool** | Copilot generated wrapup code prediction is enabled. | |
+{: class="table table-striped"}
+
+
diff --git a/build/docs/releaseNotes.md b/build/docs/releaseNotes.md
index 2317c7f78..122a24cb7 100644
--- a/build/docs/releaseNotes.md
+++ b/build/docs/releaseNotes.md
@@ -1,93 +1,338 @@
-Platform API version: 8358
+Platform API version: 8400
-# Major Changes (4 changes)
+# Major Changes (8 changes)
-**InboundRoute** (1 change)
+**GET /api/v2/analytics/reporting/settings/dashboards/query** (1 change)
-* Property imapFolder was removed
+* Parameter name was added
-**ContactBulkSearchParameters** (1 change)
+**GET /api/v2/journey/views** (1 change)
-* Property generateDownloadUri was removed
+* Parameter id was added
-**ContactBulkEditRequest** (1 change)
+**JourneyViewElementFilterRangeData** (1 change)
-* Property generateDownloadUri was removed
+* Property number was changed from integer to number
-**InboundDomain** (1 change)
+**ActivityCodesReference** (1 change)
-* Property imapSettings was removed
+* Property id was removed
+**FunctionZipConfig** (4 changes)
-# Minor Changes (20 changes)
+* status has been made readonly
+* id has been made readonly
+* name has been made readonly
+* dateCreated has been made readonly
-**/api/v2/authorization/roles/settings** (3 changes)
+
+# Minor Changes (95 changes)
+
+**/api/v2/assistants/{assistantId}/copilot** (3 changes)
* Path was added
* Operation GET was added
* Operation PUT was added
-**/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/query** (2 changes)
+**/api/v2/assistants/{assistantId}/queues/{queueId}** (4 changes)
+
+* Path was added
+* Operation GET was added
+* Operation PUT was added
+* Operation DELETE was added
+
+**/api/v2/assistants/{assistantId}/queues** (4 changes)
+
+* Path was added
+* Operation GET was added
+* Operation DELETE was added
+* Operation PATCH was added
+
+**/api/v2/assistants/{assistantId}** (4 changes)
* Path was added
+* Operation GET was added
+* Operation DELETE was added
+* Operation PATCH was added
+
+**/api/v2/assistants** (3 changes)
+
+* Path was added
+* Operation GET was added
* Operation POST was added
-**WorkPlanBidRanks** (1 change)
+**/api/v2/assistants/queues** (2 changes)
+
+* Path was added
+* Operation GET was added
+
+**/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/answers** (2 changes)
+
+* Path was added
+* Operation POST was added
+
+**/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}** (1 change)
+
+* Operation patch was added. Summary: Update feedback on a document
+
+**/api/v2/knowledge/guest/sessions/{sessionId}/documents/answers** (2 changes)
+
+* Path was added
+* Operation POST was added
+
+**/api/v2/routing/queues/{queueId}/assistant** (2 changes)
+
+* Path was added
+* Operation GET was added
+
+**/api/v2/externalcontacts/externalsources/{externalSourceId}** (4 changes)
+
+* Path was added
+* Operation GET was added
+* Operation PUT was added
+* Operation DELETE was added
+
+**/api/v2/externalcontacts/externalsources** (3 changes)
+
+* Path was added
+* Operation GET was added
+* Operation POST was added
+
+**ReportingTurnAction** (2 changes)
+
+* Enum value GetAttributesAction was added to property actionType
+* Enum value SetAttributesAction was added to property actionType
+
+**ReportingExportJobResponse** (2 changes)
+
+* Enum value SOCIAL_LISTENING_POSTS_VIEW was added to property viewType
+* Enum value AGENT_PERFORMANCE_TIMELINE_DETAIL_VIEW was added to property viewType
+
+**ReportingExportMetadataJobResponse** (2 changes)
+
+* Enum value SOCIAL_LISTENING_POSTS_VIEW was added to property viewType
+* Enum value AGENT_PERFORMANCE_TIMELINE_DETAIL_VIEW was added to property viewType
+
+**ReportingExportJobRequest** (2 changes)
+
+* Enum value SOCIAL_LISTENING_POSTS_VIEW was added to property viewType
+* Enum value AGENT_PERFORMANCE_TIMELINE_DETAIL_VIEW was added to property viewType
+
+**AnswerGenerationConfig** (1 change)
+
+* Model was added
+
+**Copilot** (1 change)
+
+* Model was added
+
+**CopilotAction** (1 change)
+
+* Model was added
+
+**CopilotCondition** (1 change)
+
+* Model was added
+
+**CopilotFallbackAction** (1 change)
+
+* Model was added
+
+**CopilotNluDomain** (1 change)
+
+* Model was added
+
+**CopilotNluDomainVersion** (1 change)
+
+* Model was added
+
+**CopilotRule** (1 change)
+
+* Model was added
+
+**Fallback** (1 change)
+
+* Model was added
+
+**KnowledgeAnswerConfig** (1 change)
+
+* Model was added
+
+**NluConfig** (1 change)
+
+* Model was added
+
+**RuleConfig** (1 change)
-* id is no longer readonly
+* Model was added
+
+**RuleEngineConfig** (1 change)
+
+* Model was added
+
+**SummaryGenerationConfig** (1 change)
+
+* Model was added
+
+**WrapupCodePredictionConfig** (1 change)
+
+* Model was added
+
+**Assistant** (1 change)
-**FlowAggregationQuery** (1 change)
+* Model was added
+
+**AssistantQueue** (1 change)
-* Enum value flowSubType was added to property groupBy
+* Model was added
-**TextBotUserAgent** (2 changes)
+**ConversationProfile** (1 change)
-* Enum value Open was added to property name
-* Enum value Instagram was added to property name
+* Model was added
-**RoleSettings** (1 change)
+**GoogleDialogflowConfig** (1 change)
* Model was added
-**AiAnswer** (1 change)
+**KnowledgeBaseWithDialectReference** (1 change)
+
+* Model was added
-* Enum value LowHistoricalAccuracyError was added to property failureType
+**KnowledgeSuggestionConfig** (1 change)
+
+* Model was added
+
+**TranscriptionConfig** (1 change)
+
+* Model was added
-**KnowledgeDocumentQueryResponse** (1 change)
+**AssistantQueueListing** (1 change)
* Model was added
-**KnowledgeDocumentQuery** (1 change)
+**AssistantListing** (1 change)
* Model was added
-**ResponseQueryRequest** (1 change)
+**TransferRequest** (1 change)
-* Optional property pageNumber was added
+* Optional property keepInternalMessageAlive was added
+
+**TransferToAgentRequest** (1 change)
+
+* Optional property keepInternalMessageAlive was added
+
+**TransferToQueueRequest** (1 change)
+
+* Optional property keepInternalMessageAlive was added
+
+**TransferToExternalRequest** (1 change)
+
+* Optional property keepInternalMessageAlive was added
+
+**CampaignRuleConditionGroup** (1 change)
+
+* Model was added
+
+**KnowledgeAnswerDocumentResponse** (1 change)
+
+* Model was added
+
+**KnowledgeAnswerDocumentsResponse** (1 change)
+
+* Model was added
+
+**KnowledgeDocumentsAnswerFilter** (1 change)
+
+* Model was added
+
+**KnowledgeDocumentFeedbackUpdateRequest** (1 change)
+
+* Model was added
-**PostTextRequest** (2 changes)
+**IpAddressRange** (1 change)
-* Enum value Open was added to property messagingPlatformType
-* Enum value Instagram was added to property messagingPlatformType
+* Enum value audio-connector was added to property service
-**FlowAsyncAggregationQuery** (1 change)
+**KnowledgeGuestAnswerDocumentResponse** (1 change)
-* Enum value flowSubType was added to property groupBy
+* Model was added
+
+**KnowledgeGuestAnswerDocumentsResponse** (1 change)
+
+* Model was added
+
+**ResponseText** (1 change)
+
+* Optional property type was added
+
+**RoutingConversationAttributesResponse** (1 change)
+
+* Optional property label was added
+
+**RoutingConversationAttributesRequest** (1 change)
+
+* Optional property labelId was added
+
+**ConversationAppSettings** (1 change)
+
+* Optional property notifications was added
+
+**BuActivitySettingsResponse** (1 change)
+
+* Model was added
+
+**BuNotificationSettingsResponse** (1 change)
+
+* Model was added
+
+**BuScheduleNotificationsCategorySettings** (1 change)
+
+* Model was added
+
+**BuScheduleNotificationsSettingsResponse** (1 change)
+
+* Model was added
+
+**BuActivitySettingsRequest** (1 change)
+
+* Model was added
+
+**BuNotificationSettingsRequest** (1 change)
+
+* Model was added
+
+**BuScheduleNotificationsSettingsRequest** (1 change)
+
+* Model was added
+
+**WorkitemFlowReference** (1 change)
+
+* Model was added
+
+**WorkitemRuleSettings** (1 change)
+
+* Model was added
+
+**CursorExternalSourceListing** (1 change)
+
+* Model was added
-**TaskManagementAggregationView** (1 change)
+**FunctionConfig** (1 change)
-* Enum value tWorkitemsAgentFocusComplete was added to property target
+* Optional property uploadExceptionHistory was added
-**TaskManagementAsyncAggregationQuery** (1 change)
+**FunctionZipConfig** (2 changes)
-* Enum value tWorkitemsAgentFocusComplete was added to property metrics
+* Optional property errorMessage was added
+* Optional property requestId was added
-**TaskManagementAggregationQuery** (1 change)
-* Enum value tWorkitemsAgentFocusComplete was added to property metrics
+# Point Changes (1 change)
+**GET /api/v2/externalcontacts/contacts/{contactId}** (1 change)
-# Point Changes (0 changes)
+* Description was changed for parameter expand
diff --git a/build/setup.py b/build/setup.py
index cee852106..c253f3106 100644
--- a/build/setup.py
+++ b/build/setup.py
@@ -4,7 +4,7 @@
from setuptools import setup, find_packages
NAME = "PureCloudPlatformClientV2"
-VERSION = "210.0.0"
+VERSION = "211.0.0"
# To install the library, run the following
#
@@ -17,7 +17,7 @@
setup(
name="PureCloudPlatformClientV2",
- version="210.0.0",
+ version="211.0.0",
description="PureCloud Platform API SDK",
author="Genesys Developer Evangelists",
author_email="DeveloperEvangelists@Genesys.com",
diff --git a/releaseNotes.md b/releaseNotes.md
index 2317c7f78..122a24cb7 100644
--- a/releaseNotes.md
+++ b/releaseNotes.md
@@ -1,93 +1,338 @@
-Platform API version: 8358
+Platform API version: 8400
-# Major Changes (4 changes)
+# Major Changes (8 changes)
-**InboundRoute** (1 change)
+**GET /api/v2/analytics/reporting/settings/dashboards/query** (1 change)
-* Property imapFolder was removed
+* Parameter name was added
-**ContactBulkSearchParameters** (1 change)
+**GET /api/v2/journey/views** (1 change)
-* Property generateDownloadUri was removed
+* Parameter id was added
-**ContactBulkEditRequest** (1 change)
+**JourneyViewElementFilterRangeData** (1 change)
-* Property generateDownloadUri was removed
+* Property number was changed from integer to number
-**InboundDomain** (1 change)
+**ActivityCodesReference** (1 change)
-* Property imapSettings was removed
+* Property id was removed
+**FunctionZipConfig** (4 changes)
-# Minor Changes (20 changes)
+* status has been made readonly
+* id has been made readonly
+* name has been made readonly
+* dateCreated has been made readonly
-**/api/v2/authorization/roles/settings** (3 changes)
+
+# Minor Changes (95 changes)
+
+**/api/v2/assistants/{assistantId}/copilot** (3 changes)
* Path was added
* Operation GET was added
* Operation PUT was added
-**/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/query** (2 changes)
+**/api/v2/assistants/{assistantId}/queues/{queueId}** (4 changes)
+
+* Path was added
+* Operation GET was added
+* Operation PUT was added
+* Operation DELETE was added
+
+**/api/v2/assistants/{assistantId}/queues** (4 changes)
+
+* Path was added
+* Operation GET was added
+* Operation DELETE was added
+* Operation PATCH was added
+
+**/api/v2/assistants/{assistantId}** (4 changes)
* Path was added
+* Operation GET was added
+* Operation DELETE was added
+* Operation PATCH was added
+
+**/api/v2/assistants** (3 changes)
+
+* Path was added
+* Operation GET was added
* Operation POST was added
-**WorkPlanBidRanks** (1 change)
+**/api/v2/assistants/queues** (2 changes)
+
+* Path was added
+* Operation GET was added
+
+**/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/answers** (2 changes)
+
+* Path was added
+* Operation POST was added
+
+**/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}** (1 change)
+
+* Operation patch was added. Summary: Update feedback on a document
+
+**/api/v2/knowledge/guest/sessions/{sessionId}/documents/answers** (2 changes)
+
+* Path was added
+* Operation POST was added
+
+**/api/v2/routing/queues/{queueId}/assistant** (2 changes)
+
+* Path was added
+* Operation GET was added
+
+**/api/v2/externalcontacts/externalsources/{externalSourceId}** (4 changes)
+
+* Path was added
+* Operation GET was added
+* Operation PUT was added
+* Operation DELETE was added
+
+**/api/v2/externalcontacts/externalsources** (3 changes)
+
+* Path was added
+* Operation GET was added
+* Operation POST was added
+
+**ReportingTurnAction** (2 changes)
+
+* Enum value GetAttributesAction was added to property actionType
+* Enum value SetAttributesAction was added to property actionType
+
+**ReportingExportJobResponse** (2 changes)
+
+* Enum value SOCIAL_LISTENING_POSTS_VIEW was added to property viewType
+* Enum value AGENT_PERFORMANCE_TIMELINE_DETAIL_VIEW was added to property viewType
+
+**ReportingExportMetadataJobResponse** (2 changes)
+
+* Enum value SOCIAL_LISTENING_POSTS_VIEW was added to property viewType
+* Enum value AGENT_PERFORMANCE_TIMELINE_DETAIL_VIEW was added to property viewType
+
+**ReportingExportJobRequest** (2 changes)
+
+* Enum value SOCIAL_LISTENING_POSTS_VIEW was added to property viewType
+* Enum value AGENT_PERFORMANCE_TIMELINE_DETAIL_VIEW was added to property viewType
+
+**AnswerGenerationConfig** (1 change)
+
+* Model was added
+
+**Copilot** (1 change)
+
+* Model was added
+
+**CopilotAction** (1 change)
+
+* Model was added
+
+**CopilotCondition** (1 change)
+
+* Model was added
+
+**CopilotFallbackAction** (1 change)
+
+* Model was added
+
+**CopilotNluDomain** (1 change)
+
+* Model was added
+
+**CopilotNluDomainVersion** (1 change)
+
+* Model was added
+
+**CopilotRule** (1 change)
+
+* Model was added
+
+**Fallback** (1 change)
+
+* Model was added
+
+**KnowledgeAnswerConfig** (1 change)
+
+* Model was added
+
+**NluConfig** (1 change)
+
+* Model was added
+
+**RuleConfig** (1 change)
-* id is no longer readonly
+* Model was added
+
+**RuleEngineConfig** (1 change)
+
+* Model was added
+
+**SummaryGenerationConfig** (1 change)
+
+* Model was added
+
+**WrapupCodePredictionConfig** (1 change)
+
+* Model was added
+
+**Assistant** (1 change)
-**FlowAggregationQuery** (1 change)
+* Model was added
+
+**AssistantQueue** (1 change)
-* Enum value flowSubType was added to property groupBy
+* Model was added
-**TextBotUserAgent** (2 changes)
+**ConversationProfile** (1 change)
-* Enum value Open was added to property name
-* Enum value Instagram was added to property name
+* Model was added
-**RoleSettings** (1 change)
+**GoogleDialogflowConfig** (1 change)
* Model was added
-**AiAnswer** (1 change)
+**KnowledgeBaseWithDialectReference** (1 change)
+
+* Model was added
-* Enum value LowHistoricalAccuracyError was added to property failureType
+**KnowledgeSuggestionConfig** (1 change)
+
+* Model was added
+
+**TranscriptionConfig** (1 change)
+
+* Model was added
-**KnowledgeDocumentQueryResponse** (1 change)
+**AssistantQueueListing** (1 change)
* Model was added
-**KnowledgeDocumentQuery** (1 change)
+**AssistantListing** (1 change)
* Model was added
-**ResponseQueryRequest** (1 change)
+**TransferRequest** (1 change)
-* Optional property pageNumber was added
+* Optional property keepInternalMessageAlive was added
+
+**TransferToAgentRequest** (1 change)
+
+* Optional property keepInternalMessageAlive was added
+
+**TransferToQueueRequest** (1 change)
+
+* Optional property keepInternalMessageAlive was added
+
+**TransferToExternalRequest** (1 change)
+
+* Optional property keepInternalMessageAlive was added
+
+**CampaignRuleConditionGroup** (1 change)
+
+* Model was added
+
+**KnowledgeAnswerDocumentResponse** (1 change)
+
+* Model was added
+
+**KnowledgeAnswerDocumentsResponse** (1 change)
+
+* Model was added
+
+**KnowledgeDocumentsAnswerFilter** (1 change)
+
+* Model was added
+
+**KnowledgeDocumentFeedbackUpdateRequest** (1 change)
+
+* Model was added
-**PostTextRequest** (2 changes)
+**IpAddressRange** (1 change)
-* Enum value Open was added to property messagingPlatformType
-* Enum value Instagram was added to property messagingPlatformType
+* Enum value audio-connector was added to property service
-**FlowAsyncAggregationQuery** (1 change)
+**KnowledgeGuestAnswerDocumentResponse** (1 change)
-* Enum value flowSubType was added to property groupBy
+* Model was added
+
+**KnowledgeGuestAnswerDocumentsResponse** (1 change)
+
+* Model was added
+
+**ResponseText** (1 change)
+
+* Optional property type was added
+
+**RoutingConversationAttributesResponse** (1 change)
+
+* Optional property label was added
+
+**RoutingConversationAttributesRequest** (1 change)
+
+* Optional property labelId was added
+
+**ConversationAppSettings** (1 change)
+
+* Optional property notifications was added
+
+**BuActivitySettingsResponse** (1 change)
+
+* Model was added
+
+**BuNotificationSettingsResponse** (1 change)
+
+* Model was added
+
+**BuScheduleNotificationsCategorySettings** (1 change)
+
+* Model was added
+
+**BuScheduleNotificationsSettingsResponse** (1 change)
+
+* Model was added
+
+**BuActivitySettingsRequest** (1 change)
+
+* Model was added
+
+**BuNotificationSettingsRequest** (1 change)
+
+* Model was added
+
+**BuScheduleNotificationsSettingsRequest** (1 change)
+
+* Model was added
+
+**WorkitemFlowReference** (1 change)
+
+* Model was added
+
+**WorkitemRuleSettings** (1 change)
+
+* Model was added
+
+**CursorExternalSourceListing** (1 change)
+
+* Model was added
-**TaskManagementAggregationView** (1 change)
+**FunctionConfig** (1 change)
-* Enum value tWorkitemsAgentFocusComplete was added to property target
+* Optional property uploadExceptionHistory was added
-**TaskManagementAsyncAggregationQuery** (1 change)
+**FunctionZipConfig** (2 changes)
-* Enum value tWorkitemsAgentFocusComplete was added to property metrics
+* Optional property errorMessage was added
+* Optional property requestId was added
-**TaskManagementAggregationQuery** (1 change)
-* Enum value tWorkitemsAgentFocusComplete was added to property metrics
+# Point Changes (1 change)
+**GET /api/v2/externalcontacts/contacts/{contactId}** (1 change)
-# Point Changes (0 changes)
+* Description was changed for parameter expand
diff --git a/swagger.json b/swagger.json
index bbfae78e4..17ad258db 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":"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"}],"schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/api/v2/events/conversations":{"post":{"tags":["Events"],"summary":"Publish Conversation Batch Events","description":"","operationId":"postEventsConversations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"batchRequest","required":true,"schema":{"$ref":"#/definitions/BatchConversationEventRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BatchEventResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","zero.events.submitted":"A minimum of 1 event must be submitted","max.batch.size.surpassed":"Max allowed event count per request has been surpassed. Max batch size is 100","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:conversation:inject"]},"x-purecloud-method-name":"postEventsConversations"}},"/api/v2/events/users/routingstatus":{"post":{"tags":["Events"],"summary":"Publish Agent Routing Status Batch Events","description":"","operationId":"postEventsUsersRoutingstatus","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"batchRequest","required":true,"schema":{"$ref":"#/definitions/BatchUserRoutingStatusEventRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BatchEventResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","zero.events.submitted":"A minimum of 1 event must be submitted","max.batch.size.surpassed":"Max allowed event count per request has been surpassed. Max batch size is 100","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:routingstatus:inject"]},"x-purecloud-method-name":"postEventsUsersRoutingstatus"}},"/api/v2/events/users/presence":{"post":{"tags":["Events"],"summary":"Publish User Presence Status Batch Events","description":"","operationId":"postEventsUsersPresence","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"batchRequest","required":true,"schema":{"$ref":"#/definitions/BatchUserPresenceEventRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BatchEventResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","zero.events.submitted":"A minimum of 1 event must be submitted","max.batch.size.surpassed":"Max allowed event count per request has been surpassed. Max batch size is 100","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["presence:userPresence:inject"]},"x-purecloud-method-name":"postEventsUsersPresence"}},"/api/v2/authorization/divisions/home":{"get":{"tags":["Authorization","Objects"],"summary":"Retrieve the home division for the organization.","description":"Will not include object counts.","operationId":"getAuthorizationDivisionsHome","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisionsHome"}},"/api/v2/authorization/divisions/limit":{"get":{"tags":["Authorization","Objects"],"summary":"Returns the maximum allowed number of divisions.","description":"","operationId":"getAuthorizationDivisionsLimit","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"integer","format":"int32"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisionsLimit"}},"/api/v2/authorization/divisions/{divisionId}":{"get":{"tags":["Authorization","Objects"],"summary":"Returns an authorization division.","description":"","operationId":"getAuthorizationDivision","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"objectCount","in":"query","description":"Get count of objects in this division, grouped by type","required":false,"type":"boolean","default":false,"enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivision"},"put":{"tags":["Authorization","Objects"],"summary":"Update a division.","description":"","operationId":"putAuthorizationDivision","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Updated division data","required":true,"schema":{"$ref":"#/definitions/AuthzDivision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.name.invalid":"The requested division name is invalid.","max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:division:edit"]},"x-purecloud-method-name":"putAuthorizationDivision"},"delete":{"tags":["Authorization","Objects"],"summary":"Delete a division.","description":"","operationId":"deleteAuthorizationDivision","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"force","in":"query","description":"Force delete this division as well as the grants and objects associated with it","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"precondition.failure":"One or more preconditions was not met.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:division:delete"]},"x-purecloud-method-name":"deleteAuthorizationDivision"}},"/api/v2/authorization/divisions/{divisionId}/restore":{"post":{"tags":["Authorization","Objects"],"summary":"Recreate a previously deleted division.","description":"","operationId":"postAuthorizationDivisionRestore","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Recreated division data","required":false,"schema":{"$ref":"#/definitions/AuthzDivision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.name.invalid":"The requested division name is invalid.","max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","max.scopes.exceeded":"Too many divisions for organization.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.already.exists":"Scope with that ID already exists"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:division:add"]},"x-purecloud-method-name":"postAuthorizationDivisionRestore"}},"/api/v2/authorization/divisions":{"get":{"tags":["Authorization","Objects"],"summary":"Retrieve a list of all divisions defined for the organization","description":"Request specific divisions by id using a query param \"id\", e.g. \n?id=5f777167-63be-4c24-ad41-374155d9e28b&id=72e9fb25-c484-488d-9312-7acba82435b3","operationId":"getAuthorizationDivisions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"objectCount","in":"query","description":"Include the count of objects contained in the division","required":false,"type":"boolean","default":false},{"name":"id","in":"query","description":"Optionally request specific divisions by their IDs","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Search term to filter by division name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivisionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisions"},"post":{"tags":["Authorization","Objects"],"summary":"Create a division.","description":"","operationId":"postAuthorizationDivisions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Division","required":true,"schema":{"$ref":"#/definitions/AuthzDivision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.name.invalid":"The requested division name is invalid.","max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","max.scopes.exceeded":"Too many divisions for organization.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.already.exists":"A resource with that name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:division:add","authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationDivisions"}},"/api/v2/authorization/divisionspermitted/me":{"get":{"tags":["Authorization","Users"],"summary":"Returns which divisions the current user has the given permission in.","description":"This route is deprecated, use authorization/divisionspermitted/paged/me instead.","operationId":"getAuthorizationDivisionspermittedMe","produces":["application/json"],"parameters":[{"name":"name","in":"query","description":"Search term to filter by division name","required":false,"type":"string"},{"name":"permission","in":"query","description":"The permission string, including the object to access, e.g. routing:queue:view","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/AuthzDivision"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.permission.param":"Missing required permission parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getAuthorizationDivisionspermittedMe"}},"/api/v2/authorization/divisionspermitted/paged/me":{"get":{"tags":["Authorization","Users"],"summary":"Returns which divisions the current user has the given permission in.","description":"","operationId":"getAuthorizationDivisionspermittedPagedMe","produces":["application/json"],"parameters":[{"name":"permission","in":"query","description":"The permission string, including the object to access, e.g. routing:queue:view","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DivsPermittedEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.permission.param":"Missing required permission parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisionspermittedPagedMe"}},"/api/v2/authorization/divisionspermitted/paged/{subjectId}":{"get":{"tags":["Authorization","Users"],"summary":"Returns which divisions the specified user has the given permission in.","description":"This route is deprecated, use authorization/divisionspermitted/paged/me instead.","operationId":"getAuthorizationDivisionspermittedPagedSubjectId","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"name":"permission","in":"query","description":"The permission string, including the object to access, e.g. routing:queue:view","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DivsPermittedEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.permission.param":"Missing required permission parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getAuthorizationDivisionspermittedPagedSubjectId"}},"/api/v2/authorization/permissions":{"get":{"tags":["Authorization"],"summary":"Get all permissions.","description":"Retrieve a list of all permission defined in the system.","operationId":"getAuthorizationPermissions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"queryType","in":"query","description":"Query filter type","required":false,"type":"string","enum":["domain","permission"]},{"name":"query","in":"query","description":"Comma-separated list of permissions or domains to query","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PermissionCollectionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationPermissions"}},"/api/v2/authorization/products":{"get":{"tags":["Authorization"],"summary":"Get the list of enabled products","description":"Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.","operationId":"getAuthorizationProducts","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationProductEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationProducts"}},"/api/v2/users/{userId}/verifiers":{"get":{"tags":["Users"],"summary":"Get a list of verifiers","description":"","operationId":"getUserVerifiers","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VerifierEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["mfa:verifier:view"]},"x-purecloud-method-name":"getUserVerifiers"}},"/api/v2/users/{userId}/verifiers/{verifierId}":{"put":{"tags":["Users"],"summary":"Update a verifier","description":"","operationId":"putUserVerifier","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"verifierId","in":"path","description":"Verifier ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Verifier Update","required":true,"schema":{"$ref":"#/definitions/UpdateVerifierRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Verifier"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["mfa:verifier:edit"]},"x-purecloud-method-name":"putUserVerifier"},"delete":{"tags":["Users"],"summary":"Delete a verifier","description":"","operationId":"deleteUserVerifier","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"verifierId","in":"path","description":"Verifier ID","required":true,"type":"string"}],"responses":{"204":{"description":"The verifier was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["mfa:verifier:delete"]},"x-purecloud-method-name":"deleteUserVerifier"}},"/api/v2/identityproviders/adfs":{"get":{"tags":["Identity Provider"],"summary":"Get ADFS Identity Provider","description":"","operationId":"getIdentityprovidersAdfs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ADFS"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersAdfs"},"put":{"tags":["Identity Provider"],"summary":"Update/Create ADFS Identity Provider","description":"","operationId":"putIdentityprovidersAdfs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/ADFS"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersAdfs"},"delete":{"tags":["Identity Provider"],"summary":"Delete ADFS Identity Provider","description":"","operationId":"deleteIdentityprovidersAdfs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersAdfs"}},"/api/v2/identityproviders/cic":{"get":{"tags":["Identity Provider"],"summary":"Get Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"getIdentityprovidersCic","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CustomerInteractionCenter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersCic"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"putIdentityprovidersCic","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/CustomerInteractionCenter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersCic"},"delete":{"tags":["Identity Provider"],"summary":"Delete Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"deleteIdentityprovidersCic","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersCic"}},"/api/v2/identityproviders/gsuite":{"get":{"tags":["Identity Provider"],"summary":"Get G Suite Identity Provider","description":"","operationId":"getIdentityprovidersGsuite","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GSuite"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersGsuite"},"put":{"tags":["Identity Provider"],"summary":"Update/Create G Suite Identity Provider","description":"","operationId":"putIdentityprovidersGsuite","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/GSuite"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersGsuite"},"delete":{"tags":["Identity Provider"],"summary":"Delete G Suite Identity Provider","description":"","operationId":"deleteIdentityprovidersGsuite","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersGsuite"}},"/api/v2/identityproviders/generic":{"get":{"tags":["Identity Provider"],"summary":"Get Generic SAML Identity Provider","description":"","operationId":"getIdentityprovidersGeneric","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GenericSAML"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersGeneric"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Generic SAML Identity Provider","description":"","operationId":"putIdentityprovidersGeneric","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/GenericSAML"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.provider.name":"The name for a generic SAML provider cannot be blank or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","provider.logo.too.large":"The logo image size is greater than allowed value of 25kb.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","invalid.nameid.format":"The name identifier format is invalid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersGeneric"},"delete":{"tags":["Identity Provider"],"summary":"Delete Generic SAML Identity Provider","description":"","operationId":"deleteIdentityprovidersGeneric","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersGeneric"}},"/api/v2/identityproviders/identitynow":{"get":{"tags":["Identity Provider"],"summary":"Get IdentityNow Provider","description":"","operationId":"getIdentityprovidersIdentitynow","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityNow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersIdentitynow"},"put":{"tags":["Identity Provider"],"summary":"Update/Create IdentityNow Provider","description":"","operationId":"putIdentityprovidersIdentitynow","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/IdentityNow"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityNow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersIdentitynow"},"delete":{"tags":["Identity Provider"],"summary":"Delete IdentityNow Provider","description":"","operationId":"deleteIdentityprovidersIdentitynow","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersIdentitynow"}},"/api/v2/identityproviders/{providerId}":{"get":{"tags":["Identity Provider"],"summary":"Get Identity Provider","description":"","operationId":"getIdentityprovider","produces":["application/json"],"parameters":[{"name":"providerId","in":"path","description":"Provider ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CustomProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovider"},"put":{"tags":["Identity Provider"],"summary":"Update Identity Provider","description":"","operationId":"putIdentityprovider","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/CustomProvider"}},{"name":"providerId","in":"path","description":"Provider ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CustomProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.provider.name":"The name for a provider cannot be blank or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","provider.logo.too.large":"The logo image size is greater than allowed value of 25kb.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","invalid.nameid.format":"The name identifier format is invalid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovider"},"delete":{"tags":["Identity Provider"],"summary":"Delete Identity Provider","description":"","operationId":"deleteIdentityprovider","produces":["application/json"],"parameters":[{"name":"providerId","in":"path","description":"Provider ID","required":true,"type":"string"}],"responses":{"204":{"description":"The provider has been deleted successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovider"}},"/api/v2/identityproviders":{"get":{"tags":["Identity Provider"],"summary":"The list of identity providers","description":"","operationId":"getIdentityproviders","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProviderEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityproviders"},"post":{"tags":["Identity Provider"],"summary":"Create Identity Provider","description":"","operationId":"postIdentityproviders","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/CustomProvider"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CustomProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.provider.name":"The name for a provider cannot be blank or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","provider.logo.too.large":"The logo image size is greater than allowed value of 25kb.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","invalid.nameid.format":"The name identifier format is invalid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add"]},"x-purecloud-method-name":"postIdentityproviders"}},"/api/v2/oauth/authorizations/{clientId}":{"get":{"tags":["OAuth"],"summary":"Get a client that is authorized by the resource owner","description":"","operationId":"getOauthAuthorization","produces":["application/json"],"parameters":[{"name":"Accept-Language","in":"header","description":"The language in which to display the client descriptions.","required":false,"type":"string","default":"en-us"},{"name":"clientId","in":"path","description":"The ID of client","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:authorize"]},"x-purecloud-method-name":"getOauthAuthorization"}},"/api/v2/oauth/authorizations":{"get":{"tags":["OAuth"],"summary":"List clients that have been authorized, requested, or revoked by the resource owner","description":"","operationId":"getOauthAuthorizations","produces":["application/json"],"parameters":[{"name":"Accept-Language","in":"header","description":"The language in which to display the client descriptions.","required":false,"type":"string","default":"en-us"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthAuthorizationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:authorize"]},"x-purecloud-method-name":"getOauthAuthorizations"}},"/api/v2/oauth/scopes/{scopeId}":{"get":{"tags":["OAuth"],"summary":"An OAuth scope","description":"","operationId":"getOauthScope","produces":["application/json"],"parameters":[{"name":"scopeId","in":"path","description":"Scope ID","required":true,"type":"string"},{"name":"Accept-Language","in":"header","description":"The language with which to display the scope description.","required":false,"type":"string","default":"en-us"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthScope"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-purecloud-method-name":"getOauthScope"}},"/api/v2/oauth/scopes":{"get":{"tags":["OAuth"],"summary":"The list of OAuth scopes","description":"","operationId":"getOauthScopes","produces":["application/json"],"parameters":[{"name":"Accept-Language","in":"header","description":"The language with which to display the scope descriptions.","required":false,"type":"string","default":"en-us"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthScopeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-purecloud-method-name":"getOauthScopes"}},"/api/v2/identityproviders/okta":{"get":{"tags":["Identity Provider"],"summary":"Get Okta Identity Provider","description":"","operationId":"getIdentityprovidersOkta","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Okta"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersOkta"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Okta Identity Provider","description":"","operationId":"putIdentityprovidersOkta","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/Okta"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersOkta"},"delete":{"tags":["Identity Provider"],"summary":"Delete Okta Identity Provider","description":"","operationId":"deleteIdentityprovidersOkta","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersOkta"}},"/api/v2/identityproviders/onelogin":{"get":{"tags":["Identity Provider"],"summary":"Get OneLogin Identity Provider","description":"","operationId":"getIdentityprovidersOnelogin","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OneLogin"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersOnelogin"},"put":{"tags":["Identity Provider"],"summary":"Update/Create OneLogin Identity Provider","description":"","operationId":"putIdentityprovidersOnelogin","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/OneLogin"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersOnelogin"},"delete":{"tags":["Identity Provider"],"summary":"Delete OneLogin Identity Provider","description":"","operationId":"deleteIdentityprovidersOnelogin","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersOnelogin"}},"/api/v2/identityproviders/ping":{"get":{"tags":["Identity Provider"],"summary":"Get Ping Identity Provider","description":"","operationId":"getIdentityprovidersPing","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PingIdentity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersPing"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Ping Identity Provider","description":"","operationId":"putIdentityprovidersPing","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/PingIdentity"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersPing"},"delete":{"tags":["Identity Provider"],"summary":"Delete Ping Identity Provider","description":"","operationId":"deleteIdentityprovidersPing","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersPing"}},"/api/v2/identityproviders/purecloud":{"get":{"tags":["Identity Provider"],"summary":"Get PureCloud Identity Provider","description":"","operationId":"getIdentityprovidersPurecloud","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PureCloud"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersPurecloud"},"put":{"tags":["Identity Provider"],"summary":"Update/Create PureCloud Identity Provider","description":"","operationId":"putIdentityprovidersPurecloud","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/PureCloud"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersPurecloud"},"delete":{"tags":["Identity Provider"],"summary":"Delete PureCloud Identity Provider","description":"","operationId":"deleteIdentityprovidersPurecloud","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersPurecloud"}},"/api/v2/identityproviders/pureengage":{"get":{"tags":["Identity Provider"],"summary":"Get PureEngage Identity Provider","description":"","operationId":"getIdentityprovidersPureengage","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PureEngage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersPureengage"},"put":{"tags":["Identity Provider"],"summary":"Update/Create PureEngage Identity Provider","description":"","operationId":"putIdentityprovidersPureengage","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/PureEngage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersPureengage"},"delete":{"tags":["Identity Provider"],"summary":"Delete PureEngage Identity Provider","description":"","operationId":"deleteIdentityprovidersPureengage","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersPureengage"}},"/api/v2/identityproviders/salesforce":{"get":{"tags":["Identity Provider"],"summary":"Get Salesforce Identity Provider","description":"","operationId":"getIdentityprovidersSalesforce","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Salesforce"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersSalesforce"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Salesforce Identity Provider","description":"","operationId":"putIdentityprovidersSalesforce","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/Salesforce"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersSalesforce"},"delete":{"tags":["Identity Provider"],"summary":"Delete Salesforce Identity Provider","description":"","operationId":"deleteIdentityprovidersSalesforce","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersSalesforce"}},"/api/v2/organizations/embeddedintegration":{"get":{"tags":["Organization"],"summary":"Get the list of domains that will be allowed to embed PureCloud applications","description":"This route is deprecated, please use /api/v2/organizations/authentication/settings instead","operationId":"getOrganizationsEmbeddedintegration","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmbeddedIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getOrganizationsEmbeddedintegration"},"put":{"tags":["Organization"],"summary":"Update the list of domains that will be allowed to embed PureCloud applications","description":"This route is deprecated, please use /api/v2/organizations/authentication/settings instead","operationId":"putOrganizationsEmbeddedintegration","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Whitelist settings","required":true,"schema":{"$ref":"#/definitions/EmbeddedIntegration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmbeddedIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsEmbeddedintegration"}},"/api/v2/organizations/ipaddressauthentication":{"get":{"tags":["Organization"],"summary":"Get organization IP address whitelist settings","description":"This route is deprecated, please use /api/v2/organizations/authentication/settings instead","operationId":"getOrganizationsIpaddressauthentication","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IpAddressAuthentication"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"getOrganizationsIpaddressauthentication"},"put":{"tags":["Organization"],"summary":"Update organization IP address whitelist settings","description":"This route is deprecated, please use /api/v2/organizations/authentication/settings instead","operationId":"putOrganizationsIpaddressauthentication","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"IP address Whitelist settings","required":true,"schema":{"$ref":"#/definitions/IpAddressAuthentication"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IpAddressAuthentication"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.issuing.ip.address":"IP address whitelisting cannot be configured with a token that was issued outside of the allowed ranges.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.ip.address":"IP address whitelisting cannot be configured from outside of the allowed ranges.","invalid.host.address":"IP address whitelisting cannot be configured via requests made to this host."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsIpaddressauthentication"}},"/api/v2/organizations/whitelist":{"get":{"tags":["Organization"],"summary":"This route is deprecated, please use /api/v2/organizations/authentication/settings instead","description":"","operationId":"getOrganizationsWhitelist","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgWhitelistSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getOrganizationsWhitelist"},"put":{"tags":["Organization"],"summary":"This route is deprecated, please use /api/v2/organizations/authentication/settings instead","description":"","operationId":"putOrganizationsWhitelist","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Whitelist settings","required":true,"schema":{"$ref":"#/definitions/OrgWhitelistSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgWhitelistSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsWhitelist"}},"/api/v2/organizations/authentication/settings":{"get":{"tags":["Organization"],"summary":"Gets the organization's settings","description":"","operationId":"getOrganizationsAuthenticationSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgAuthSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"getOrganizationsAuthenticationSettings"},"patch":{"tags":["Organization"],"summary":"Update the organization's settings","description":"","operationId":"patchOrganizationsAuthenticationSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Org settings","required":true,"schema":{"$ref":"#/definitions/OrgAuthSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgAuthSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"patchOrganizationsAuthenticationSettings"}},"/api/v2/tokens/me":{"get":{"tags":["Tokens"],"summary":"Fetch information about the current token","description":"","operationId":"getTokensMe","produces":["application/json"],"parameters":[{"name":"preserveIdleTTL","in":"query","description":"preserveIdleTTL indicates whether the idle token timeout should be reset or preserved. If preserveIdleTTL is true, then TTL value is not reset. If unset or false, the value is reset.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TokenInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"getTokensMe"},"head":{"tags":["Tokens"],"summary":"Verify user token","description":"","operationId":"headTokensMe","produces":["application/json"],"parameters":[],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"headTokensMe"},"delete":{"tags":["Tokens"],"summary":"Delete auth token used to make the request.","description":"","operationId":"deleteTokensMe","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"deleteTokensMe"}},"/api/v2/tokens/{userId}":{"delete":{"tags":["Tokens"],"summary":"Delete all auth tokens for the specified user.","description":"","operationId":"deleteToken","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Missing required division permission","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:token:delete"]},"x-purecloud-method-name":"deleteToken"}},"/api/v2/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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getAlertingAlertsActive"}},"/api/v2/alerting/interactionstats/alerts/{alertId}":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats alert","description":"Apps should migrate to use GET /api/v2/alerting/alerts/{alertId}.","operationId":"getAlertingInteractionstatsAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsAlert"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsAlert"},"put":{"tags":["Alerting"],"summary":"Update an interaction stats alert read status","description":"Apps should migrate to use PUT /api/v2/alerting/alerts/{alertId}.","operationId":"putAlertingInteractionstatsAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"},{"in":"body","name":"body","description":"InteractionStatsAlert","required":true,"schema":{"$ref":"#/definitions/UnreadStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnreadStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:edit"]},"x-purecloud-method-name":"putAlertingInteractionstatsAlert"},"delete":{"tags":["Alerting"],"summary":"Delete an interaction stats alert","description":"Apps should migrate to use DELETE /api/v2/alerting/alerts/{alertId}.","operationId":"deleteAlertingInteractionstatsAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"}],"responses":{"204":{"description":"Interaction stats alert deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:delete"]},"x-purecloud-method-name":"deleteAlertingInteractionstatsAlert"}},"/api/v2/alerting/interactionstats/alerts":{"get":{"tags":["Alerting"],"summary":"Get interaction stats alert list","description":"Apps should migrate to use POST /api/v2/alerting/alerts/query.","operationId":"getAlertingInteractionstatsAlerts","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsAlertContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsAlerts"}},"/api/v2/alerting/interactionstats/rules/{ruleId}":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats rule","description":"Apps should migrate to use GET /api/v2/alerting/rules/{ruleId}.","operationId":"getAlertingInteractionstatsRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsRule"},"put":{"tags":["Alerting"],"summary":"Update an interaction stats rule","description":"Apps should migrate to use PUT /api/v2/alerting/rules/{ruleId}.","operationId":"putAlertingInteractionstatsRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"},{"in":"body","name":"body","description":"AlertingRule","required":true,"schema":{"$ref":"#/definitions/InteractionStatsRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:edit"]},"x-purecloud-method-name":"putAlertingInteractionstatsRule"},"delete":{"tags":["Alerting"],"summary":"Delete an interaction stats rule","description":"Apps should migrate to use DELETE /api/v2/alerting/rules/{ruleId}.","operationId":"deleteAlertingInteractionstatsRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"}],"responses":{"204":{"description":"Interaction stats rule deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:delete"]},"x-purecloud-method-name":"deleteAlertingInteractionstatsRule"}},"/api/v2/alerting/interactionstats/rules":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats rule list","description":"Apps should migrate to use POST /api/v2/alerting/rules/query.","operationId":"getAlertingInteractionstatsRules","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRuleContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsRules"},"post":{"tags":["Alerting"],"summary":"Create an interaction stats rule","description":"Apps should migrate to use POST /api/v2/alerting/rules.","operationId":"postAlertingInteractionstatsRules","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"},{"in":"body","name":"body","description":"AlertingRule","required":true,"schema":{"$ref":"#/definitions/InteractionStatsRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:add"]},"x-purecloud-method-name":"postAlertingInteractionstatsRules"}},"/api/v2/alerting/interactionstats/alerts/unread":{"get":{"tags":["Alerting"],"summary":"Gets user unread count of interaction stats alerts","description":"Apps should migrate to use POST /api/v2/alerting/alerts/query with the queryType set to 'Count' and viewStatus to 'Unread' in the request body.","operationId":"getAlertingInteractionstatsAlertsUnread","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnreadMetric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getAlertingInteractionstatsAlertsUnread"}},"/api/v2/analytics/actions/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for action aggregates","description":"","operationId":"postAnalyticsActionsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ActionAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"postAnalyticsActionsAggregatesQuery"}},"/api/v2/analytics/bots/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for bot aggregates","description":"","operationId":"postAnalyticsBotsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/BotAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:botAggregate:view"]},"x-purecloud-method-name":"postAnalyticsBotsAggregatesQuery"}},"/api/v2/analytics/conversations/{conversationId}/details":{"get":{"tags":["Analytics","Conversations"],"summary":"Get a conversation by id","description":"","operationId":"getAnalyticsConversationDetails","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationDetails"}},"/api/v2/analytics/conversations/details":{"get":{"tags":["Analytics","Conversations"],"summary":"Gets multiple conversations by id","description":"","operationId":"getAnalyticsConversationsDetails","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Comma-separated conversation ids","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributesMultiGetResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetails"}},"/api/v2/analytics/conversations/{conversationId}/details/properties":{"post":{"tags":["Analytics","Conversations"],"summary":"Index conversation properties","description":"","operationId":"postAnalyticsConversationDetailsProperties","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"request","required":true,"schema":{"$ref":"#/definitions/PropertyIndexRequest"}}],"responses":{"202":{"description":"Accepted - Indexing properties","schema":{"$ref":"#/definitions/PropertyIndexRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationProperties:index"]},"x-purecloud-method-name":"postAnalyticsConversationDetailsProperties"}},"/api/v2/analytics/conversations/details/jobs":{"post":{"tags":["Analytics","Conversations"],"summary":"Query for conversation details asynchronously","description":"","operationId":"postAnalyticsConversationsDetailsJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AsyncConversationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"postAnalyticsConversationsDetailsJobs"}},"/api/v2/analytics/conversations/details/jobs/{jobId}":{"get":{"tags":["Analytics","Conversations"],"summary":"Get status for async query for conversation details","description":"","operationId":"getAnalyticsConversationsDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetailsJob"},"delete":{"tags":["Analytics","Conversations"],"summary":"Delete/cancel an async details job","description":"","operationId":"deleteAnalyticsConversationsDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"deleteAnalyticsConversationsDetailsJob"}},"/api/v2/analytics/conversations/details/jobs/{jobId}/results":{"get":{"tags":["Analytics","Conversations"],"summary":"Fetch a page of results for an async details job","description":"","operationId":"getAnalyticsConversationsDetailsJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The desired maximum number of results","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationAsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetailsJobResults"}},"/api/v2/analytics/conversations/details/jobs/availability":{"get":{"tags":["Analytics","Conversations"],"summary":"Lookup the datalake availability date and time","description":"","operationId":"getAnalyticsConversationsDetailsJobsAvailability","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataAvailabilityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetailsJobsAvailability"}},"/api/v2/analytics/conversations/activity/query":{"post":{"tags":["Analytics","Conversations"],"summary":"Query for conversation activity observations","description":"","operationId":"postAnalyticsConversationsActivityQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ConversationActivityQuery"}},{"name":"pageSize","in":"query","description":"The desired page size","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The desired page number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationActivityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:queueObservation:view"]},"x-purecloud-method-name":"postAnalyticsConversationsActivityQuery"}},"/api/v2/analytics/conversations/details/query":{"post":{"tags":["Analytics","Conversations"],"summary":"Query for conversation details","description":"","operationId":"postAnalyticsConversationsDetailsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ConversationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"payload.too.large":"The response payload was too large.","request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"postAnalyticsConversationsDetailsQuery"}},"/api/v2/analytics/conversations/aggregates/query":{"post":{"tags":["Analytics","Conversations"],"summary":"Query for conversation aggregates","description":"","operationId":"postAnalyticsConversationsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ConversationAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationAggregate:view"]},"x-purecloud-method-name":"postAnalyticsConversationsAggregatesQuery"}},"/api/v2/analytics/evaluations/aggregates/query":{"post":{"tags":["Analytics","Quality"],"summary":"Query for evaluation aggregates","description":"","operationId":"postAnalyticsEvaluationsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/EvaluationAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:evaluationAggregate:view"]},"x-purecloud-method-name":"postAnalyticsEvaluationsAggregatesQuery"}},"/api/v2/analytics/flowexecutions/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for flow execution aggregates","description":"","operationId":"postAnalyticsFlowexecutionsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowExecutionAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowExecutionAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowExecutionAggregate:view"]},"x-purecloud-method-name":"postAnalyticsFlowexecutionsAggregatesQuery"}},"/api/v2/analytics/flows/aggregates/query":{"post":{"tags":["Analytics","Flows"],"summary":"Query for flow aggregates","description":"","operationId":"postAnalyticsFlowsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to query for flow aggregates.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowAggregate:view"]},"x-purecloud-method-name":"postAnalyticsFlowsAggregatesQuery"}},"/api/v2/analytics/flows/observations/query":{"post":{"tags":["Analytics","Flows"],"summary":"Query for flow observations","description":"","operationId":"postAnalyticsFlowsObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowObservation:view"]},"x-purecloud-method-name":"postAnalyticsFlowsObservationsQuery"}},"/api/v2/analytics/flows/activity/query":{"post":{"tags":["Analytics","Flows"],"summary":"Query for flow activity observations","description":"","operationId":"postAnalyticsFlowsActivityQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowActivityQuery"}},{"name":"pageSize","in":"query","description":"The desired page size","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The desired page number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowActivityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowObservation:view"]},"x-purecloud-method-name":"postAnalyticsFlowsActivityQuery"}},"/api/v2/analytics/journeys/aggregates/query":{"post":{"tags":["Analytics","Journey"],"summary":"Query for journey aggregates","description":"","operationId":"postAnalyticsJourneysAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/JourneyAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:journeyAggregate:view"]},"x-purecloud-method-name":"postAnalyticsJourneysAggregatesQuery"}},"/api/v2/analytics/knowledge/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for knowledge aggregates","description":"","operationId":"postAnalyticsKnowledgeAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/KnowledgeAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:knowledgeAggregate:view"]},"x-purecloud-method-name":"postAnalyticsKnowledgeAggregatesQuery"}},"/api/v2/analytics/queues/observations/query":{"post":{"tags":["Analytics","Routing"],"summary":"Query for queue observations","description":"","operationId":"postAnalyticsQueuesObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/QueueObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"This user is not permitted to query for queue.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:queueObservation:view"]},"x-purecloud-method-name":"postAnalyticsQueuesObservationsQuery"}},"/api/v2/analytics/ratelimits/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for limits rate limit aggregates. Data populated when limits 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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:rateLimitAggregate:view"]},"x-purecloud-method-name":"postAnalyticsRatelimitsAggregatesQuery"}},"/api/v2/analytics/routing/activity/query":{"post":{"tags":["Analytics","Routing"],"summary":"Query for user activity observations","description":"","operationId":"postAnalyticsRoutingActivityQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/RoutingActivityQuery"}},{"name":"pageSize","in":"query","description":"The desired page size","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The desired page number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingActivityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:queueObservation:view"]},"x-purecloud-method-name":"postAnalyticsRoutingActivityQuery"}},"/api/v2/analytics/surveys/aggregates/query":{"post":{"tags":["Analytics","Quality"],"summary":"Query for survey aggregates","description":"","operationId":"postAnalyticsSurveysAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/SurveyAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:surveyAggregate:view"]},"x-purecloud-method-name":"postAnalyticsSurveysAggregatesQuery"}},"/api/v2/analytics/teams/activity/query":{"post":{"tags":["Analytics","Teams"],"summary":"Query for team activity observations","description":"","operationId":"postAnalyticsTeamsActivityQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TeamActivityQuery"}},{"name":"pageSize","in":"query","description":"The desired page size","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The desired page number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TeamActivityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:teamObservation:view"]},"x-purecloud-method-name":"postAnalyticsTeamsActivityQuery"}},"/api/v2/analytics/transcripts/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for transcript aggregates","description":"","operationId":"postAnalyticsTranscriptsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TranscriptAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:speechAndTextAnalyticsAggregates:view"]},"x-purecloud-method-name":"postAnalyticsTranscriptsAggregatesQuery"}},"/api/v2/analytics/users/aggregates/query":{"post":{"tags":["Analytics","Users"],"summary":"Query for user aggregates","description":"","operationId":"postAnalyticsUsersAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userAggregate:view"]},"x-purecloud-method-name":"postAnalyticsUsersAggregatesQuery"}},"/api/v2/analytics/users/details/query":{"post":{"tags":["Analytics","Users"],"summary":"Query for user details","description":"","operationId":"postAnalyticsUsersDetailsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserDetailsQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsUserDetailsQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"postAnalyticsUsersDetailsQuery"}},"/api/v2/analytics/users/observations/query":{"post":{"tags":["Analytics","Users"],"summary":"Query for user observations","description":"","operationId":"postAnalyticsUsersObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userObservation:view"]},"x-purecloud-method-name":"postAnalyticsUsersObservationsQuery"}},"/api/v2/analytics/users/activity/query":{"post":{"tags":["Analytics","Users"],"summary":"Query for user activity observations","description":"","operationId":"postAnalyticsUsersActivityQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserActivityQuery"}},{"name":"pageSize","in":"query","description":"The desired page size","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The desired page number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserActivityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userObservation:view"]},"x-purecloud-method-name":"postAnalyticsUsersActivityQuery"}},"/api/v2/analytics/users/details/jobs":{"post":{"tags":["Analytics","Users"],"summary":"Query for user details asynchronously","description":"","operationId":"postAnalyticsUsersDetailsJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AsyncUserDetailsQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"postAnalyticsUsersDetailsJobs"}},"/api/v2/analytics/users/details/jobs/{jobId}":{"get":{"tags":["Analytics","Users"],"summary":"Get status for async query for user details","description":"","operationId":"getAnalyticsUsersDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"getAnalyticsUsersDetailsJob"},"delete":{"tags":["Analytics","Users"],"summary":"Delete/cancel an async request","description":"","operationId":"deleteAnalyticsUsersDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"deleteAnalyticsUsersDetailsJob"}},"/api/v2/analytics/users/details/jobs/{jobId}/results":{"get":{"tags":["Analytics","Users"],"summary":"Fetch a page of results for an async query","description":"","operationId":"getAnalyticsUsersDetailsJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The desired maximum number of results","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsUserDetailsAsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"getAnalyticsUsersDetailsJobResults"}},"/api/v2/analytics/users/details/jobs/availability":{"get":{"tags":["Analytics","Users"],"summary":"Lookup the datalake availability date and time","description":"","operationId":"getAnalyticsUsersDetailsJobsAvailability","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataAvailabilityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"getAnalyticsUsersDetailsJobsAvailability"}},"/api/v2/analytics/botflows/{botFlowId}/divisions/reportingturns":{"get":{"tags":["Analytics"],"summary":"Get Reporting Turns (division aware).","description":"Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of 'nextUri' in the response, until it's no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.","operationId":"getAnalyticsBotflowDivisionsReportingturns","produces":["application/json"],"parameters":[{"name":"botFlowId","in":"path","description":"ID of the bot flow.","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the ID of the last item in the list of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Max number of entities to return. Maximum of 250","required":false,"type":"string","default":"50"},{"name":"interval","in":"query","description":"Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval","x-example":"2023-07-17T08:15:44.586Z/2023-07-26T09:22:33.111Z"},{"name":"actionId","in":"query","description":"Optional action ID to get the reporting turns associated to a particular flow action","required":false,"type":"string"},{"name":"sessionId","in":"query","description":"Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed.","required":false,"type":"string"},{"name":"language","in":"query","description":"Optional language code to get the reporting turns for a particular language","required":false,"type":"string","x-example":"en-us"},{"name":"askActionResults","in":"query","description":"Optional case-insensitive comma separated list of ask action results to filter the reporting turns.","required":false,"type":"string","enum":["AgentRequestedByUser","ConfirmationRequired","DisambiguationRequired","Error","ExpressionError","NoInputCollection","NoInputConfirmation","NoInputDisambiguation","NoMatchCollection","NoMatchConfirmation","NoMatchDisambiguation","SuccessCollection","SuccessConfirmationNo","SuccessConfirmationYes","SuccessDisambiguation","SuccessDisambiguationNone"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingTurnsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:botFlowDivisionAwareReportingTurn:view"]},"x-purecloud-method-name":"getAnalyticsBotflowDivisionsReportingturns"}},"/api/v2/analytics/botflows/{botFlowId}/reportingturns":{"get":{"tags":["Analytics"],"summary":"Get Reporting Turns.","description":"Deprecated: Please use GET /analytics/botflows/{botFlowId}/divisions/reportingturns instead. Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of 'nextUri' in the response, until it's no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.","operationId":"getAnalyticsBotflowReportingturns","produces":["application/json"],"parameters":[{"name":"botFlowId","in":"path","description":"ID of the bot flow.","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the ID of the last item in the list of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Max number of entities to return. Maximum of 250","required":false,"type":"string","default":"50"},{"name":"interval","in":"query","description":"Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval","x-example":"2023-07-17T08:15:44.586Z/2023-07-26T09:22:33.111Z"},{"name":"actionId","in":"query","description":"Optional action ID to get the reporting turns associated to a particular flow action","required":false,"type":"string"},{"name":"sessionId","in":"query","description":"Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed.","required":false,"type":"string"},{"name":"language","in":"query","description":"Optional language code to get the reporting turns for a particular language","required":false,"type":"string","x-example":"en-us"},{"name":"askActionResults","in":"query","description":"Optional case-insensitive comma separated list of ask action results to filter the reporting turns.","required":false,"type":"string","enum":["AgentRequestedByUser","ConfirmationRequired","DisambiguationRequired","Error","ExpressionError","NoInputCollection","NoInputConfirmation","NoInputDisambiguation","NoMatchCollection","NoMatchConfirmation","NoMatchDisambiguation","SuccessCollection","SuccessConfirmationNo","SuccessConfirmationYes","SuccessDisambiguation","SuccessDisambiguationNone"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingTurnsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:botFlowReportingTurn:view"]},"x-purecloud-method-name":"getAnalyticsBotflowReportingturns"}},"/api/v2/analytics/botflows/{botFlowId}/sessions":{"get":{"tags":["Analytics"],"summary":"Get Bot Flow Sessions.","description":"Returns the bot flow sessions in reverse chronological order from the date they were created. For pagination, clients should keep sending requests using the value of 'nextUri' in the response, until it's no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.","operationId":"getAnalyticsBotflowSessions","produces":["application/json"],"parameters":[{"name":"botFlowId","in":"path","description":"ID of the bot flow.","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the ID of the last item in the list of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Max number of entities to return. Maximum of 250","required":false,"type":"string","default":"50"},{"name":"interval","in":"query","description":"Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval","x-example":"2023-07-17T08:15:44.586Z/2023-07-26T09:22:33.111Z"},{"name":"botResultCategories","in":"query","description":"Optional case-insensitive comma separated list of Bot Result Categories to filter sessions by.","required":false,"type":"string","enum":["Unknown","UserExit","BotExit","Error","RecognitionFailure","UserDisconnect","BotDisconnect","SessionExpired","Transfer"]},{"name":"endLanguage","in":"query","description":"Optional case-insensitive language code to filter sessions by the language the sessions ended in.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SessionsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:botFlowSession:view"]},"x-purecloud-method-name":"getAnalyticsBotflowSessions"}},"/api/v2/analytics/dataretention/settings":{"get":{"tags":["Analytics"],"summary":"Get analytics data retention setting","description":"","operationId":"getAnalyticsDataretentionSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsDataRetentionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:dataRetention:view"]},"x-purecloud-method-name":"getAnalyticsDataretentionSettings"},"put":{"tags":["Analytics"],"summary":"Update analytics data retention setting","description":"","operationId":"putAnalyticsDataretentionSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"retentionDays","required":true,"schema":{"$ref":"#/definitions/UpdateAnalyticsDataRetentionRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsDataRetentionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"analytics.data.retention.update.conflict":"The provided analytics data retention setting conflicts with existing policies/recordings in the org. Ensure that no recording policies retain recordings for longer than the provided retentionDays, and no recordings have delete dates further away from their creation dates than the provided retentionDays."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:dataRetention:edit"]},"x-purecloud-method-name":"putAnalyticsDataretentionSettings"}},"/api/v2/analytics/reporting/settings":{"get":{"tags":["Analytics"],"summary":"Get AnalyticsReportingSettings for an organization","description":"","operationId":"getAnalyticsReportingSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsReportingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-purecloud-method-name":"getAnalyticsReportingSettings"},"patch":{"tags":["Analytics"],"summary":"Patch AnalyticsReportingSettings values for an organization","description":"","operationId":"patchAnalyticsReportingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AnalyticsReportingSettingsRequest","required":true,"schema":{"$ref":"#/definitions/AnalyticsReportingSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsReportingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Unable to update AnalyticsReportingSettings due to invalid request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"AnalyticsReportingSettings for organization not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:reportingSettings:edit"]},"x-purecloud-method-name":"patchAnalyticsReportingSettings"}},"/api/v2/analytics/reporting/settings/dashboards/bulk/remove":{"post":{"tags":["Analytics"],"summary":"Bulk remove dashboard configurations","description":"","operationId":"postAnalyticsReportingSettingsDashboardsBulkRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/DashboardConfigurationBulkRequest"}}],"responses":{"204":{"description":"Dashboard Configurations were deleted successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dashboardConfigurations:edit"]},"x-purecloud-method-name":"postAnalyticsReportingSettingsDashboardsBulkRemove"}},"/api/v2/analytics/reporting/settings/dashboards/query":{"get":{"tags":["Analytics"],"summary":"Get list of dashboard configurations","description":"","operationId":"getAnalyticsReportingSettingsDashboardsQuery","produces":["application/json"],"parameters":[{"name":"dashboardType","in":"query","description":"List dashboard of given type","required":true,"type":"string","enum":["All","Public","Private","Shared","Favorites"]},{"name":"dashboardAccessFilter","in":"query","description":"Filter dashboard based on the owner of dashboard","required":true,"type":"string","enum":["OwnedByMe","OwnedByAnyone","NotOwnedByMe"]},{"name":"sortBy","in":"query","required":false,"type":"string","default":"desc"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","required":false,"type":"integer","default":9,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DashboardConfigurationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dashboardConfigurations:view"]},"x-purecloud-method-name":"getAnalyticsReportingSettingsDashboardsQuery"},"post":{"tags":["Analytics"],"summary":"Query dashboard configurations","description":"","operationId":"postAnalyticsReportingSettingsDashboardsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/DashboardConfigurationQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DashboardConfigurationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dashboardConfigurations:view"]},"x-purecloud-method-name":"postAnalyticsReportingSettingsDashboardsQuery"}},"/api/v2/analytics/reporting/dashboards/users/{userId}":{"get":{"tags":["Analytics"],"summary":"Get dashboards summary for a user","description":"","operationId":"getAnalyticsReportingDashboardsUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DashboardUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dashboardConfigurations:view"]},"x-purecloud-method-name":"getAnalyticsReportingDashboardsUser"}},"/api/v2/analytics/reporting/dashboards/users/bulk/remove":{"post":{"tags":["Analytics"],"summary":"Bulk delete dashboards owned by other user(s)","description":"","operationId":"postAnalyticsReportingDashboardsUsersBulkRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"List of userIds","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"Dashboards were deleted successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:dashboardConfigurations:deleteActive","analytics:dashboardConfigurations:deleteInactive"]},"x-purecloud-method-name":"postAnalyticsReportingDashboardsUsersBulkRemove"}},"/api/v2/analytics/reporting/dashboards/users":{"get":{"tags":["Analytics"],"summary":"Get dashboards summary for users in a org","description":"","operationId":"getAnalyticsReportingDashboardsUsers","produces":["application/json"],"parameters":[{"name":"sortBy","in":"query","required":false,"type":"string","default":"asc"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","required":false,"type":"integer","default":25,"format":"int32"},{"name":"id","in":"query","description":"A list of user IDs to fetch by bulk","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"state","in":"query","description":"Only list users of this state","required":false,"type":"string","enum":["active","inactive"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DashboardUserListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dashboardConfigurations:view"]},"x-purecloud-method-name":"getAnalyticsReportingDashboardsUsers"}},"/api/v2/analytics/reporting/settings/users/{userId}/dashboards":{"get":{"tags":["Analytics"],"summary":"Get list of dashboards for an user","description":"","operationId":"getAnalyticsReportingSettingsUserDashboards","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"sortBy","in":"query","required":false,"type":"string","default":"asc"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","required":false,"type":"integer","default":50,"format":"int32"},{"name":"publicOnly","in":"query","description":"If true, retrieve only public dashboards","required":false,"type":"boolean"},{"name":"favoriteOnly","in":"query","description":"If true, retrieve only favorite dashboards","required":false,"type":"boolean"},{"name":"name","in":"query","description":"retrieve dashboards that match with given name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DashboardConfigurationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dashboardConfigurations:viewPrivate"]},"x-purecloud-method-name":"getAnalyticsReportingSettingsUserDashboards"}},"/api/v2/analytics/reporting/exports/metadata":{"get":{"tags":["Analytics"],"summary":"Get all export metadata","description":"","operationId":"getAnalyticsReportingExportsMetadata","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingExportMetadataJobListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dataExport:view"]},"x-purecloud-method-name":"getAnalyticsReportingExportsMetadata"}},"/api/v2/analytics/reporting/exports":{"get":{"tags":["Analytics"],"summary":"Get all view export requests for a user","description":"","operationId":"getAnalyticsReportingExports","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingExportJobListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dataExport:view"]},"x-purecloud-method-name":"getAnalyticsReportingExports"},"post":{"tags":["Analytics"],"summary":"Generate a view export request","description":"This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead","operationId":"postAnalyticsReportingExports","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ReportingExportJobRequest","required":true,"schema":{"$ref":"#/definitions/ReportingExportJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingExportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Bad user request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to generate a view export request.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dataExport:add"]},"x-purecloud-method-name":"postAnalyticsReportingExports"}},"/api/v2/audits/query":{"post":{"tags":["Audit"],"summary":"Create audit query execution","description":"Use /api/v2/audits/query/servicemapping endpoint for a list of valid values","operationId":"postAuditsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AuditQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"202":{"description":"Accepted - Query execution is accepted.","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"postAuditsQuery"}},"/api/v2/audits/query/{transactionId}":{"get":{"tags":["Audit"],"summary":"Get status of audit query execution","description":"","operationId":"getAuditsQueryTransactionId","produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"Transaction ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"202":{"description":"In progress - Query execution is in progress.","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryTransactionId"}},"/api/v2/audits/query/{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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"postAuditsQueryRealtime"}},"/api/v2/audits/query/realtime/related":{"post":{"tags":["Audit"],"summary":"Often a single action results in multiple audits. The endpoint retrieves all audits created by the same action as the given audit id.","description":"","operationId":"postAuditsQueryRealtimeRelated","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AuditRealtimeRelatedRequest"}},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["user"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditRealtimeRelatedResultsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"postAuditsQueryRealtimeRelated"}},"/api/v2/audits/query/servicemapping":{"get":{"tags":["Audit"],"summary":"Get service mapping information used in audits.","description":"","operationId":"getAuditsQueryServicemapping","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryServiceMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryServicemapping"}},"/api/v2/audits/query/realtime/servicemapping":{"get":{"tags":["Audit"],"summary":"Get service mapping information used in realtime audits.","description":"","operationId":"getAuditsQueryRealtimeServicemapping","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryServiceMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryRealtimeServicemapping"}},"/api/v2/authorization/divisions/{divisionId}/objects/{objectType}":{"post":{"tags":["Authorization","Objects"],"summary":"Assign a list of objects to a division","description":"Set the division of a specified list of objects. The objects must all be of the same type, one of: \nCAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. \nThe body of the request is a list of object IDs, which are expected to be \nGUIDs, e.g. [\"206ce31f-61ec-40ed-a8b1-be6f06303998\",\"250a754e-f5e4-4f51-800f-a92f09d3bf8c\"]","operationId":"postAuthorizationDivisionObject","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"objectType","in":"path","description":"The type of the objects. Must be one of the valid object types","required":true,"type":"string","enum":["QUEUE","CAMPAIGN","CONTACTLIST","DNCLIST","EMAILCAMPAIGN","MESSAGINGCAMPAIGN","MANAGEMENTUNIT","BUSINESSUNIT","FLOW","FLOWMILESTONE","FLOWOUTCOME","USER","CALLROUTE","EMERGENCYGROUPS","ROUTINGSCHEDULES","ROUTINGSCHEDULEGROUPS","DATATABLES","TEAM","WORKBIN","WORKTYPE","EXTENSIONPOOL","SKILLGROUP","SCRIPT"]},{"in":"body","name":"body","description":"Object Id List","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"The divisions were updated successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","too.many.bulk.division.updates":"Unable to move objects because the request contained too many objects","empty.bulk.division.update":"Unable to move object because the request contained an empty object.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","bulk.move.no.permission.division":"Unable to move object(s) because the requesting user does not have edit permission in the destination division","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.units.not.found":"One or more requested management units were not found","wfm.business.units.not.found":"One or more requested business units were not found","general.resource.not.found":"Requested resource is not available.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bulk.move.unable.to.move":"One or more of the object(s) failed to be moved to the destination division"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed","bulk.move.permission.check.error":"Failed to check permissions in one or more of the divisions in the request","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-purecloud-method-name":"postAuthorizationDivisionObject"}},"/api/v2/authorization/subjects/me":{"get":{"tags":["Authorization","Users"],"summary":"Returns a listing of roles and permissions for the currently authenticated user.","description":"","operationId":"getAuthorizationSubjectsMe","produces":["application/json"],"parameters":[{"name":"includeDuplicates","in":"query","description":"Include multiple entries with the same role and division but different subjects","required":false,"type":"boolean","default":false,"enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzSubject"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationSubjectsMe"}},"/api/v2/authorization/subjects/{subjectId}/bulkadd":{"post":{"tags":["Authorization","Users"],"summary":"Bulk-grant roles and divisions to a subject.","description":"","operationId":"postAuthorizationSubjectBulkadd","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"in":"body","name":"body","description":"Pairs of role and division IDs","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}},{"name":"subjectType","in":"query","description":"what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)","required":false,"type":"string","default":"PC_USER"}],"responses":{"204":{"description":"Bulk Grants Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.assignments.exceeded":"Too many roles granted to a subject","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","bad.role.divisions":"Invalid role divisions in request."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationSubjectBulkadd"}},"/api/v2/authorization/subjects/{subjectId}/bulkreplace":{"post":{"tags":["Authorization","Users"],"summary":"Replace subject's roles and divisions with the exact list supplied in the request.","description":"This operation will not remove grants that are inherited from group membership. It will only set the grants directly applied to the subject.","operationId":"postAuthorizationSubjectBulkreplace","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"in":"body","name":"body","description":"Pairs of role and division IDs","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}},{"name":"subjectType","in":"query","description":"what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)","required":false,"type":"string","default":"PC_USER"}],"responses":{"204":{"description":"Bulk Grants Replaced"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.assignments.exceeded":"Too many roles granted to a subject","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","bad.role.divisions":"Invalid role divisions in request."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:grant:add","authorization:grant:delete"]},"x-purecloud-method-name":"postAuthorizationSubjectBulkreplace"}},"/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}":{"post":{"tags":["Authorization","Users"],"summary":"Make a grant of a role in a division","description":"","operationId":"postAuthorizationSubjectDivisionRole","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"name":"divisionId","in":"path","description":"the id of the division to which to make the grant","required":true,"type":"string"},{"name":"roleId","in":"path","description":"the id of the role to grant","required":true,"type":"string"},{"name":"subjectType","in":"query","description":"what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints)","required":false,"type":"string","default":"PC_USER"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.assignments.exceeded":"Too many roles granted to a subject","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationSubjectDivisionRole"},"delete":{"tags":["Authorization","Users"],"summary":"Delete a grant of a role in a division","description":"","operationId":"deleteAuthorizationSubjectDivisionRole","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"name":"divisionId","in":"path","description":"the id of the division of the grant","required":true,"type":"string"},{"name":"roleId","in":"path","description":"the id of the role of the grant","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:grant:delete"]},"x-purecloud-method-name":"deleteAuthorizationSubjectDivisionRole"}},"/api/v2/authorization/subjects/{subjectId}/bulkremove":{"post":{"tags":["Authorization","Users"],"summary":"Bulk-remove grants from a subject.","description":"","operationId":"postAuthorizationSubjectBulkremove","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"in":"body","name":"body","description":"Pairs of role and division IDs","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}}],"responses":{"204":{"description":"Bulk Grants Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:grant:delete"]},"x-purecloud-method-name":"postAuthorizationSubjectBulkremove"}},"/api/v2/authorization/subjects/{subjectId}":{"get":{"tags":["Authorization","Users"],"summary":"Returns a listing of roles and permissions for a user.","description":"","operationId":"getAuthorizationSubject","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"name":"includeDuplicates","in":"query","description":"Include multiple entries with the same role and division but different subjects","required":false,"type":"boolean","default":false,"enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzSubject"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has ocurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getAuthorizationSubject"}},"/api/v2/authorization/roles/{roleId}/users/remove":{"put":{"tags":["Authorization"],"summary":"Removes the users from the role","description":"","operationId":"putAuthorizationRoleUsersRemove","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of user IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:delete"]},"x-purecloud-method-name":"putAuthorizationRoleUsersRemove"}},"/api/v2/authorization/roles/{roleId}/users":{"get":{"tags":["Authorization"],"summary":"Get a list of the users in a specified role.","description":"Get an array of the UUIDs of the users in the specified role.","operationId":"getAuthorizationRoleUsers","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationRoleUsers"}},"/api/v2/authorization/roles/{roleId}/users/add":{"put":{"tags":["Authorization"],"summary":"Sets the users for the role","description":"","operationId":"putAuthorizationRoleUsersAdd","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of user IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.assignments.exceeded":"Too many roles granted to a subject","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"putAuthorizationRoleUsersAdd"}},"/api/v2/authorization/divisions/{divisionId}/grants":{"get":{"tags":["Authorization"],"summary":"Gets all grants for a given division.","description":"Returns all grants assigned to a given division. Maximum page size is 500.","operationId":"getAuthorizationDivisionGrants","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivisionGrantEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getAuthorizationDivisionGrants"}},"/api/v2/authorization/settings":{"get":{"tags":["Authorization"],"summary":"Get authorization settings","description":"","operationId":"getAuthorizationSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthorizationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin","authorization:settings:view"]},"x-purecloud-method-name":"getAuthorizationSettings"},"patch":{"tags":["Authorization"],"summary":"Change authorization settings","description":"Change authorization settings","operationId":"patchAuthorizationSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Authorization Settings","required":true,"schema":{"$ref":"#/definitions/AuthorizationSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthorizationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin","authorization:settings:edit"]},"x-purecloud-method-name":"patchAuthorizationSettings"}},"/api/v2/authorization/roles/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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal service error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRole"},"post":{"tags":["Authorization"],"summary":"Bulk-grant subjects and divisions with an organization role.","description":"","operationId":"postAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Subjects and Divisions","required":true,"schema":{"$ref":"#/definitions/SubjectDivisions"}},{"name":"subjectType","in":"query","description":"what the type of the subjects are (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)","required":false,"type":"string","default":"PC_USER"}],"responses":{"204":{"description":"Bulk Grants Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.assignments.exceeded":"Too many roles granted to a subject","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.subject.type":"Bad request, invalid subject type","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationRole"},"put":{"tags":["Authorization"],"summary":"Update an organization role.","description":"Update","operationId":"putAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRoleUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"putAuthorizationRole"},"delete":{"tags":["Authorization"],"summary":"Delete an organization role.","description":"","operationId":"deleteAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:delete"]},"x-purecloud-method-name":"deleteAuthorizationRole"},"patch":{"tags":["Authorization"],"summary":"Patch Organization Role for needsUpdate Field","description":"Patch Organization Role for needsUpdate Field","operationId":"patchAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRole"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"patchAuthorizationRole"}},"/api/v2/authorization/roles":{"get":{"tags":["Authorization"],"summary":"Retrieve a list of all roles defined for the organization","description":"","operationId":"getAuthorizationRoles","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","required":false,"type":"string"},{"name":"permission","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"defaultRoleId","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"userCount","in":"query","required":false,"type":"boolean","default":true},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.ids":"Only 100 roles can be requested at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"The service is currently unavailable."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRoles"},"post":{"tags":["Authorization"],"summary":"Create an organization role.","description":"","operationId":"postAuthorizationRoles","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRoleCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:add"]},"x-purecloud-method-name":"postAuthorizationRoles"}},"/api/v2/authorization/roles/default":{"post":{"tags":["Authorization"],"summary":"Restores all default roles","description":"This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.","operationId":"postAuthorizationRolesDefault","produces":["application/json"],"parameters":[{"name":"force","in":"query","description":"Restore default roles","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"postAuthorizationRolesDefault"},"put":{"tags":["Authorization"],"summary":"Restore specified default roles","description":"","operationId":"putAuthorizationRolesDefault","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization roles list","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationRole"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"putAuthorizationRolesDefault"}},"/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}":{"get":{"tags":["Authorization"],"summary":"Get an org role to default role comparison","description":"Compares any organization role to a default role id and show differences","operationId":"getAuthorizationRoleComparedefaultRightRoleId","produces":["application/json"],"parameters":[{"name":"leftRoleId","in":"path","description":"Left Role ID","required":true,"type":"string"},{"name":"rightRoleId","in":"path","description":"Right Role id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrgRoleDifference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRoleComparedefaultRightRoleId"},"post":{"tags":["Authorization"],"summary":"Get an unsaved org role to default role comparison","description":"Allows users to compare their existing roles in an unsaved state to its default role","operationId":"postAuthorizationRoleComparedefaultRightRoleId","produces":["application/json"],"parameters":[{"name":"leftRoleId","in":"path","description":"Left Role ID","required":true,"type":"string"},{"name":"rightRoleId","in":"path","description":"Right Role id","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRole"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrgRoleDifference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"postAuthorizationRoleComparedefaultRightRoleId"}},"/api/v2/authorization/roles/{roleId}/subjectgrants":{"get":{"tags":["Authorization"],"summary":"Get the subjects' granted divisions in the specified role.","description":"Includes the divisions for which the subject has a grant.","operationId":"getAuthorizationRoleSubjectgrants","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SubjectDivisionGrantsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRoleSubjectgrants"}},"/api/v2/authorization/subjects/rolecounts":{"get":{"tags":["Authorization"],"summary":"Get the count of roles granted to a list of subjects","description":"","operationId":"getAuthorizationSubjectsRolecounts","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","max.subject.ids":"Only 100 subjects can be requested at a time.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getAuthorizationSubjectsRolecounts"}},"/api/v2/users/{subjectId}/roles":{"get":{"tags":["Authorization","Users"],"summary":"Returns a listing of roles and permissions for a user.","description":"","operationId":"getUserRoles","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getUserRoles"},"put":{"tags":["Authorization","Users"],"summary":"Sets the user's roles","description":"","operationId":"putUserRoles","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of roles","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.assignments.exceeded":"Too many roles granted to a subject","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be processed due to invalid request data.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an active user with that ID in this organization.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"The service is currently unavailable."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"putUserRoles"}},"/api/v2/screenrecording/token":{"post":{"tags":["Screen Recording"],"summary":"Sign identifying information for screen recording","description":"","operationId":"postScreenrecordingToken","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ScreenRecordingUserAuthenticatedInfo"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SignedData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization:readonly"]}],"x-purecloud-method-name":"postScreenrecordingToken"}},"/api/v2/billing/reports/billableusage":{"get":{"tags":["Billing"],"summary":"Get a report of the billable license usages","description":"Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response's status is InProgress, wait a few seconds, then try the same request again.","operationId":"getBillingReportsBillableusage","produces":["application/json"],"parameters":[{"name":"startDate","in":"query","description":"The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BillingUsageReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["billing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["billing:subscription:read","billing:subscription:view"]},"x-purecloud-method-name":"getBillingReportsBillableusage"}},"/api/v2/billing/trusteebillingoverview/{trustorOrgId}":{"get":{"tags":["Billing"],"summary":"Get the billing overview for an organization that is managed by a partner.","description":"Tax Disclaimer: Prices returned by this API do not include applicable taxes. It is the responsibility of the customer to pay all taxes that are appropriate in their jurisdiction. See the PureCloud API Documentation in the Developer Center for more information about this API: https://developer.mypurecloud.com/api/rest/v2/","operationId":"getBillingTrusteebillingoverviewTrustorOrgId","produces":["application/json"],"parameters":[{"name":"billingPeriodIndex","in":"query","description":"0 for active period (overview data may change until period closes). 1 for prior completed billing period. 2 for two billing cycles prior, and so on.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"trustorOrgId","in":"path","description":"The organization ID of the trustor (customer) organization.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrusteeBillingOverview"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["billing","billing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["affiliateOrganization:clientBilling:view"]},"x-purecloud-method-name":"getBillingTrusteebillingoverviewTrustorOrgId"}},"/api/v2/users/{userId}/callforwarding":{"get":{"tags":["Users"],"summary":"Get a user's CallForwarding","description":"","operationId":"getUserCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","callforwarding.usernotpermitted":"User is not permitted to use call forwarding","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"externalservice.unexpectedresponsecode":"Unexpected response code from external service"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserCallforwarding"},"put":{"tags":["Users"],"summary":"Update a user's CallForwarding","description":"","operationId":"putUserCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Call forwarding","required":true,"schema":{"$ref":"#/definitions/CallForwarding"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callforwarding.voicemaillastcallrequiresatleastonecalltoaphonenumber":"Setting voicemail 'lastcall' requires a call to a phone number","callforwarding.voicemailpurecloudrequiresatleastonecall":"Setting voicemail 'purecloud' cannot be used without a call","callforwarding.calltargetrequirestype":"A call target requires a type","callforwarding.enablednotallowedwhileonqueue":"Call forwarding is not allowed to be enabled while on queue","callforwarding.voicemaillastcallcannotusestation":"Setting voicemail 'lastcall' cannot be used with a station","callforwarding.enablednotallowedwithoutcalls":"Call forwarding is not allowed to be enabled without calls","callforwarding.webrtcstationmustbelongtouser":"WebRtc station must belong to the user","callforwarding.maxnumberofcallsexceeded":"The number of calls exceeds the limit","callforwarding.maxnumberofcalltargetsexceeded":"The number of targets per call exceeds the limit","callforwarding.invalidphonenumberformat":"Invalid E164 phone number","callforwarding.calltargetstationrequiresstation":"Call target with type of 'station' requires the value to be a valid station id","callforwarding.invalidextension":"Invalid extension","callforwarding.callrequiresatleastonetarget":"A call requires at least one target","callforwarding.enabledcannotbenull":"Enabled must be true or false","callforwarding.calltargetunknowntype":"A call target has unknown type","callforwarding.duplicatetargetnotallowed":"A phone number or station can only be used once","callforwarding.invalidtargettype":"Value for the target type is invalid","callforwarding.voicemailpermissionrequired":"Setting voicemail to 'purecloud' requires the user to have voicemail permission","callforwarding.calltargetphonenumberrequiresvalue":"Call target with type of 'phonenumber' requires the value to be a valid phone number or extension","callforwarding.voicemaillastcallmustbeanexternalphonenumber":"Setting voicemail to 'lastcall' requires the last call to use a single phone number to an external non-PureCloud operated number","callforwarding.calltargetrequiresvalue":"A call target requires a value","callforwarding.voicemaillastcallcannotuseextension":"Setting voicemail 'lastcall' cannot be used with an extension"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:callForwarding:edit"]},"x-purecloud-method-name":"putUserCallforwarding"},"patch":{"tags":["Users"],"summary":"Patch a user's CallForwarding","description":"","operationId":"patchUserCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Call forwarding","required":true,"schema":{"$ref":"#/definitions/CallForwarding"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callforwarding.voicemaillastcallrequiresatleastonecalltoaphonenumber":"Setting voicemail 'lastcall' requires a call to a phone number","callforwarding.voicemailpurecloudrequiresatleastonecall":"Setting voicemail 'purecloud' cannot be used without a call","callforwarding.calltargetrequirestype":"A call target requires a type","callforwarding.enablednotallowedwhileonqueue":"Call forwarding is not allowed to be enabled while on queue","callforwarding.voicemaillastcallcannotusestation":"Setting voicemail 'lastcall' cannot be used with a station","callforwarding.enablednotallowedwithoutcalls":"Call forwarding is not allowed to be enabled without calls","callforwarding.webrtcstationmustbelongtouser":"WebRtc station must belong to the user","callforwarding.maxnumberofcallsexceeded":"The number of calls exceeds the limit","callforwarding.maxnumberofcalltargetsexceeded":"The number of targets per call exceeds the limit","callforwarding.invalidphonenumberformat":"Invalid E164 phone number","callforwarding.calltargetstationrequiresstation":"Call target with type of 'station' requires the value to be a valid station id","callforwarding.invalidextension":"Invalid extension","callforwarding.callrequiresatleastonetarget":"A call requires at least one target","callforwarding.enabledcannotbenull":"Enabled must be true or false","callforwarding.calltargetunknowntype":"A call target has unknown type","callforwarding.duplicatetargetnotallowed":"A phone number or station can only be used once","callforwarding.invalidtargettype":"Value for the target type is invalid","callforwarding.voicemailpermissionrequired":"Setting voicemail to 'purecloud' requires the user to have voicemail permission","callforwarding.calltargetphonenumberrequiresvalue":"Call target with type of 'phonenumber' requires the value to be a valid phone number or extension","callforwarding.voicemaillastcallmustbeanexternalphonenumber":"Setting voicemail to 'lastcall' requires the last call to use a single phone number to an external non-PureCloud operated number","callforwarding.calltargetrequiresvalue":"A call target requires a value","callforwarding.voicemaillastcallcannotuseextension":"Setting voicemail 'lastcall' cannot be used with an extension"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:callForwarding:edit"]},"x-purecloud-method-name":"patchUserCallforwarding"}},"/api/v2/carrierservices/integrations/emergencylocations/me":{"get":{"tags":["Carrier Services"],"summary":"Get location for the logged in user","description":"","operationId":"getCarrierservicesIntegrationsEmergencylocationsMe","produces":["application/json"],"parameters":[{"name":"phoneNumber","in":"query","description":"Phone number in E164 format","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyLocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getCarrierservicesIntegrationsEmergencylocationsMe"},"post":{"tags":["Carrier Services"],"summary":"Set current location for the logged in user","description":"","operationId":"postCarrierservicesIntegrationsEmergencylocationsMe","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/EmergencyLocation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyLocation"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/EmergencyLocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorInfo"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"postCarrierservicesIntegrationsEmergencylocationsMe"}},"/api/v2/certificate/details":{"post":{"tags":["Utilities"],"summary":"Returns the information about an X509 PEM encoded certificate or certificate chain.","description":"","operationId":"postCertificateDetails","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Certificate","required":true,"schema":{"$ref":"#/definitions/Certificate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ParsedCertificate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"postCertificateDetails"}},"/api/v2/chats/settings":{"get":{"tags":["Chat"],"summary":"Get Chat Settings.","description":"","operationId":"getChatsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:setting:view","chat:setting:edit"]},"x-purecloud-method-name":"getChatsSettings"},"put":{"tags":["Chat"],"summary":"Update Chat Settings.","description":"","operationId":"putChatsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Chat","required":true,"schema":{"$ref":"#/definitions/ChatSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:setting:edit"]},"x-purecloud-method-name":"putChatsSettings"},"patch":{"tags":["Chat"],"summary":"Patch Chat Settings.","description":"","operationId":"patchChatsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Chat","required":true,"schema":{"$ref":"#/definitions/ChatSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:setting:edit"]},"x-purecloud-method-name":"patchChatsSettings"}},"/api/v2/chats/rooms/{roomJid}/messages/{messageIds}":{"get":{"tags":["Chat"],"summary":"Get messages by id(s) from a room","description":"","operationId":"getChatsRoomMessage","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"name":"messageIds","in":"path","description":"messageIds, comma separated","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:view"]},"x-purecloud-method-name":"getChatsRoomMessage"}},"/api/v2/chats/users/{userId}/messages/{messageIds}":{"get":{"tags":["Chat"],"summary":"Get messages by id(s) from a 1on1","description":"","operationId":"getChatsUserMessage","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"messageIds","in":"path","description":"messageIds, comma separated","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1Message:view"]},"x-purecloud-method-name":"getChatsUserMessage"}},"/api/v2/chats/messages/{messageId}":{"get":{"tags":["Chat"],"summary":"Get a message","description":"","operationId":"getChatsMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatMessageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1Message:view","chat:room:view"]},"x-purecloud-method-name":"getChatsMessage"}},"/api/v2/chats/messages/{messageId}/reactions":{"put":{"tags":["Chat"],"summary":"Update reactions to a message","description":"","operationId":"putChatsMessageReactions","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"},{"in":"body","name":"body","description":"reactionUpdate","required":true,"schema":{"$ref":"#/definitions/ChatReactionUpdate"}}],"responses":{"204":{"description":"Reactions updated successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:reactions:edit"]},"x-purecloud-method-name":"putChatsMessageReactions"}},"/api/v2/chats/rooms/{roomJid}/messages":{"get":{"tags":["Chat"],"summary":"Get a room's message history","description":"","operationId":"getChatsRoomMessages","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"name":"limit","in":"query","description":"The maximum number of messages to retrieve","required":false,"type":"string"},{"name":"before","in":"query","description":"The cutoff date for messages to retrieve","required":false,"type":"string"},{"name":"after","in":"query","description":"The beginning date for messages to retrieve","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:view"]},"x-purecloud-method-name":"getChatsRoomMessages"},"post":{"tags":["Chat"],"summary":"Send a message to a room","description":"","operationId":"postChatsRoomMessages","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomId","required":true,"type":"string"},{"in":"body","name":"body","description":"messageBody","required":true,"schema":{"$ref":"#/definitions/SendMessageBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSendMessageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:roomMessage:add"]},"x-purecloud-method-name":"postChatsRoomMessages"}},"/api/v2/chats/rooms/{roomJid}/messages/{messageId}":{"delete":{"tags":["Chat"],"summary":"Delete a message in a room","description":"","operationId":"deleteChatsRoomMessage","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"204":{"description":"Message deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:roomMessage:delete"]},"x-purecloud-method-name":"deleteChatsRoomMessage"},"patch":{"tags":["Chat"],"summary":"Edit a message in a room","description":"","operationId":"patchChatsRoomMessage","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"},{"in":"body","name":"body","description":"messageBody","required":true,"schema":{"$ref":"#/definitions/SendMessageBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSendMessageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:roomMessage:edit"]},"x-purecloud-method-name":"patchChatsRoomMessage"}},"/api/v2/chats/users/{userId}/messages":{"get":{"tags":["Chat"],"summary":"Get 1on1 History between a user","description":"","operationId":"getChatsUserMessages","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"limit","in":"query","description":"The maximum number of messages to retrieve","required":false,"type":"string"},{"name":"before","in":"query","description":"The cutoff date for messages to retrieve","required":false,"type":"string"},{"name":"after","in":"query","description":"The beginning date for messages to retrieve","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatMessageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1Message:view"]},"x-purecloud-method-name":"getChatsUserMessages"},"post":{"tags":["Chat"],"summary":"Send a message to a user","description":"","operationId":"postChatsUserMessages","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"in":"body","name":"body","description":"message body","required":true,"schema":{"$ref":"#/definitions/SendMessageBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSendMessageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1Message:add"]},"x-purecloud-method-name":"postChatsUserMessages"}},"/api/v2/chats/users/{userId}/messages/{messageId}":{"delete":{"tags":["Chat"],"summary":"Delete a message to a user","description":"","operationId":"deleteChatsUserMessage","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"204":{"description":"Message deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1Message:delete"]},"x-purecloud-method-name":"deleteChatsUserMessage"},"patch":{"tags":["Chat"],"summary":"Edit a message to a user","description":"","operationId":"patchChatsUserMessage","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"},{"in":"body","name":"body","description":"message body","required":true,"schema":{"$ref":"#/definitions/SendMessageBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSendMessageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1Message:view"]},"x-purecloud-method-name":"patchChatsUserMessage"}},"/api/v2/chats/rooms/{roomJid}/participants/{participantJid}":{"get":{"tags":["Chat"],"summary":"Get a room participant","description":"","operationId":"getChatsRoomParticipant","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"name":"participantJid","in":"path","description":"participantJid","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoomParticipant"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getChatsRoomParticipant"}},"/api/v2/chats/rooms/{roomJid}/participants/{userId}":{"post":{"tags":["Chat"],"summary":"Join a room","description":"","operationId":"postChatsRoomParticipant","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"name":"userId","in":"path","description":"userId","required":true,"type":"string"}],"responses":{"204":{"description":"Joined room successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:participant:add"]},"x-purecloud-method-name":"postChatsRoomParticipant"},"delete":{"tags":["Chat"],"summary":"Remove a user from a room.","description":"","operationId":"deleteChatsRoomParticipant","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"name":"userId","in":"path","description":"userId","required":true,"type":"string"}],"responses":{"204":{"description":"User removed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:participant:delete"]},"x-purecloud-method-name":"deleteChatsRoomParticipant"}},"/api/v2/chats/rooms/{roomJid}/participants":{"get":{"tags":["Chat"],"summary":"Get room participants in a room","description":"","operationId":"getChatsRoomParticipants","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoomParticipantsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:view"]},"x-purecloud-method-name":"getChatsRoomParticipants"}},"/api/v2/chats/rooms/{roomJid}":{"get":{"tags":["Chat"],"summary":"Get a room","description":"","operationId":"getChatsRoom","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Room"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:view"]},"x-purecloud-method-name":"getChatsRoom"},"patch":{"tags":["Chat"],"summary":"Set properties for a room","description":"","operationId":"patchChatsRoom","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"in":"body","name":"body","description":"Room properties","required":true,"schema":{"$ref":"#/definitions/RoomUpdateRequest"}}],"responses":{"204":{"description":"Room updated successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:edit"]},"x-purecloud-method-name":"patchChatsRoom"}},"/api/v2/chats/rooms":{"post":{"tags":["Chat"],"summary":"Create an adhoc room","description":"","operationId":"postChatsRooms","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Room properties","required":true,"schema":{"$ref":"#/definitions/CreateRoomRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateRoomResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:add"]},"x-purecloud-method-name":"postChatsRooms"}},"/api/v2/chats/rooms/{roomJid}/messages/pins":{"post":{"tags":["Chat"],"summary":"Add pinned messages for a room, up to a maximum of 5 pinned messages","description":"","operationId":"postChatsRoomMessagesPins","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"in":"body","name":"body","description":"Pinned Message Ids","required":true,"schema":{"$ref":"#/definitions/PinnedMessageRequest"}}],"responses":{"204":{"description":"Pinned messages added successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:edit"]},"x-purecloud-method-name":"postChatsRoomMessagesPins"}},"/api/v2/chats/rooms/{roomJid}/messages/pins/{pinnedMessageId}":{"delete":{"tags":["Chat"],"summary":"Remove a pinned message from a room","description":"","operationId":"deleteChatsRoomMessagesPin","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"name":"pinnedMessageId","in":"path","description":"pinnedMessageId","required":true,"type":"string"}],"responses":{"204":{"description":"Pinned message removed successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:edit"]},"x-purecloud-method-name":"deleteChatsRoomMessagesPin"}},"/api/v2/chats/threads/{threadId}/messages":{"get":{"tags":["Chat"],"summary":"Get history by thread","description":"","operationId":"getChatsThreadMessages","produces":["application/json"],"parameters":[{"name":"threadId","in":"path","description":"threadId","required":true,"type":"string"},{"name":"limit","in":"query","description":"The maximum number of messages to retrieve","required":false,"type":"string"},{"name":"before","in":"query","description":"The cutoff date for messages to retrieve","required":false,"type":"string"},{"name":"after","in":"query","description":"The beginning date for messages to retrieve","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:view"]},"x-purecloud-method-name":"getChatsThreadMessages"}},"/api/v2/conversations/{conversationId}/cobrowse":{"post":{"tags":["Conversations"],"summary":"Creates a cobrowse session. Requires \"conversation:cobrowse:add\" (for web messaging) or \"conversation:cobrowsevoice:add\" permission.","description":"","operationId":"postConversationCobrowse","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CobrowseWebMessagingSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:cobrowse:add","conversation:cobrowseVoice:add"]},"x-purecloud-method-name":"postConversationCobrowse"}},"/api/v2/scripts/{scriptId}/export":{"post":{"tags":["Scripts"],"summary":"Export a script via download service.","description":"","operationId":"postScriptExport","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ExportScriptRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportScriptResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"postScriptExport"}},"/api/v2/scripts/uploads/{uploadId}/status":{"get":{"tags":["Scripts"],"summary":"Get the upload status of an imported script","description":"","operationId":"getScriptsUploadStatus","produces":["application/json"],"parameters":[{"name":"uploadId","in":"path","description":"Upload ID","required":true,"type":"string"},{"name":"longPoll","in":"query","description":"Enable longPolling endpoint","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportScriptStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:search"]},"x-purecloud-method-name":"getScriptsUploadStatus"}},"/api/v2/scripts/{scriptId}/pages/{pageId}":{"get":{"tags":["Scripts"],"summary":"Get a page","description":"","operationId":"getScriptPage","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"pageId","in":"path","description":"Page ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Page"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScriptPage"}},"/api/v2/scripts/{scriptId}/pages":{"get":{"tags":["Scripts"],"summary":"Get the list of pages","description":"","operationId":"getScriptPages","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Page"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScriptPages"}},"/api/v2/scripts/published/{scriptId}/pages/{pageId}":{"get":{"tags":["Scripts"],"summary":"Get the published page.","description":"","operationId":"getScriptsPublishedScriptIdPage","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"pageId","in":"path","description":"Page ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Page"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptIdPage"}},"/api/v2/scripts/published/{scriptId}/pages":{"get":{"tags":["Scripts"],"summary":"Get the list of published pages","description":"","operationId":"getScriptsPublishedScriptIdPages","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Page"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptIdPages"}},"/api/v2/scripts/published/{scriptId}":{"get":{"tags":["Scripts"],"summary":"Get the published script.","description":"","operationId":"getScriptsPublishedScriptId","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Script"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptId"}},"/api/v2/scripts/published/divisionviews":{"get":{"tags":["Scripts"],"summary":"Get the published scripts metadata.","description":"","operationId":"getScriptsPublishedDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name filter","required":false,"type":"string"},{"name":"feature","in":"query","description":"Feature filter","required":false,"type":"string"},{"name":"flowId","in":"query","description":"Secure flow id filter","required":false,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"},{"name":"divisionIds","in":"query","description":"Filters scripts to requested divisionIds","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScriptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:search"]},"x-purecloud-method-name":"getScriptsPublishedDivisionviews"}},"/api/v2/scripts/published":{"get":{"tags":["Scripts"],"summary":"Get the published scripts.","description":"","operationId":"getScriptsPublished","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name filter","required":false,"type":"string"},{"name":"feature","in":"query","description":"Feature filter","required":false,"type":"string"},{"name":"flowId","in":"query","description":"Secure flow id filter","required":false,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"},{"name":"divisionIds","in":"query","description":"Filters scripts to requested divisionIds","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScriptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublished"},"post":{"tags":["Scripts"],"summary":"Publish a script.","description":"","operationId":"postScriptsPublished","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/PublishScriptRequestData"}},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Script"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","script.validation.error":"The script contained validation errors","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:add"]},"x-purecloud-method-name":"postScriptsPublished"}},"/api/v2/scripts/published/{scriptId}/variables":{"get":{"tags":["Scripts"],"summary":"Get the published variables","description":"","operationId":"getScriptsPublishedScriptIdVariables","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"input","in":"query","description":"input","required":false,"type":"string","enum":["true","false"]},{"name":"output","in":"query","description":"output","required":false,"type":"string","enum":["true","false"]},{"name":"type","in":"query","description":"type","required":false,"type":"string","enum":["string","number","boolean"]},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptIdVariables"}},"/api/v2/scripts/{scriptId}":{"get":{"tags":["Scripts"],"summary":"Get a script","description":"","operationId":"getScript","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Script"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScript"}},"/api/v2/scripts/divisionviews":{"get":{"tags":["Scripts"],"summary":"Get the metadata for a list of scripts","description":"","operationId":"getScriptsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name filter","required":false,"type":"string"},{"name":"feature","in":"query","description":"Feature filter","required":false,"type":"string"},{"name":"flowId","in":"query","description":"Secure flow id filter","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"SortBy","required":false,"type":"string","enum":["modifiedDate","createdDate"]},{"name":"sortOrder","in":"query","description":"SortOrder","required":false,"type":"string","enum":["ascending","descending"]},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"},{"name":"divisionIds","in":"query","description":"Filters scripts to requested divisionIds","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScriptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:search"]},"x-purecloud-method-name":"getScriptsDivisionviews"}},"/api/v2/scripts":{"get":{"tags":["Scripts"],"summary":"Get the list of scripts","description":"","operationId":"getScripts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name filter","required":false,"type":"string"},{"name":"feature","in":"query","description":"Feature filter","required":false,"type":"string"},{"name":"flowId","in":"query","description":"Secure flow id filter","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"SortBy","required":false,"type":"string","enum":["modifiedDate","createdDate"]},{"name":"sortOrder","in":"query","description":"SortOrder","required":false,"type":"string","enum":["ascending","descending"]},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"},{"name":"divisionIds","in":"query","description":"Filters scripts to requested divisionIds","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScriptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScripts"}},"/api/v2/conversations/keyconfigurations/{keyconfigurationsId}":{"get":{"tags":["Conversations"],"summary":"Get the encryption key configurations","description":"","operationId":"getConversationsKeyconfiguration","produces":["application/json"],"parameters":[{"name":"keyconfigurationsId","in":"path","description":"Key Configurations Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:encryptionKey:view"]},"x-purecloud-method-name":"getConversationsKeyconfiguration"},"put":{"tags":["Conversations"],"summary":"Update the encryption key configurations","description":"","operationId":"putConversationsKeyconfiguration","produces":["application/json"],"parameters":[{"name":"keyconfigurationsId","in":"path","description":"Key Configurations Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Encryption key configuration metadata","required":true,"schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:encryptionKey:edit"]},"x-purecloud-method-name":"putConversationsKeyconfiguration"}},"/api/v2/conversations/keyconfigurations":{"get":{"tags":["Conversations"],"summary":"Get a list of key configurations data","description":"","operationId":"getConversationsKeyconfigurations","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEncryptionConfigurationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:encryptionKey:view"]},"x-purecloud-method-name":"getConversationsKeyconfigurations"},"post":{"tags":["Conversations"],"summary":"Setup configurations for encryption key creation","description":"","operationId":"postConversationsKeyconfigurations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Encryption Configuration","required":true,"schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:encryptionKey:edit"]},"x-purecloud-method-name":"postConversationsKeyconfigurations"}},"/api/v2/conversations/keyconfigurations/validate":{"post":{"tags":["Conversations"],"summary":"Validate encryption key configurations without saving it","description":"","operationId":"postConversationsKeyconfigurationsValidate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Encryption Configuration","required":true,"schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:encryptionKey:edit"]},"x-purecloud-method-name":"postConversationsKeyconfigurationsValidate"}},"/api/v2/recording/crossplatform/mediaretentionpolicies":{"get":{"tags":["Recording"],"summary":"Gets media retention policy list with query options to filter on name and enabled.","description":"for a less verbose response, add summary=true to this endpoint","operationId":"getRecordingCrossplatformMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","description":"the policy name - used for filtering results in searches.","required":false,"type":"string"},{"name":"enabled","in":"query","description":"checks to see if policy is enabled - use enabled = true or enabled = false","required":false,"type":"boolean"},{"name":"summary","in":"query","description":"provides a less verbose response of policy lists.","required":false,"type":"boolean","default":false},{"name":"hasErrors","in":"query","description":"provides a way to fetch all policies with errors or policies that do not have errors","required":false,"type":"boolean"},{"name":"deleteDaysThreshold","in":"query","description":"provides a way to fetch all policies with any actions having deleteDays exceeding the provided value","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PolicyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:view"]},"x-purecloud-method-name":"getRecordingCrossplatformMediaretentionpolicies"},"post":{"tags":["Recording"],"summary":"Create media retention policy","description":"Policy does not work retroactively","operationId":"postRecordingCrossplatformMediaretentionpolicies","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/CrossPlatformPolicyCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","constraint.validation":"%s","recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:add"]},"x-purecloud-method-name":"postRecordingCrossplatformMediaretentionpolicies"},"delete":{"tags":["Recording"],"summary":"Delete media retention policies","description":"Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.","operationId":"deleteRecordingCrossplatformMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"ids","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingCrossplatformMediaretentionpolicies"}},"/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}":{"get":{"tags":["Recording"],"summary":"Get a media retention policy","description":"","operationId":"getRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:view"]},"x-purecloud-method-name":"getRecordingCrossplatformMediaretentionpolicy"},"put":{"tags":["Recording"],"summary":"Update a media retention policy","description":"Policy does not work retroactively","operationId":"putRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/CrossPlatformPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","constraint.validation":"%s","recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:edit"]},"x-purecloud-method-name":"putRecordingCrossplatformMediaretentionpolicy"},"delete":{"tags":["Recording"],"summary":"Delete a media retention policy","description":"","operationId":"deleteRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.policy.not.found":"The supplied policy was not found or is invalid","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingCrossplatformMediaretentionpolicy"},"patch":{"tags":["Recording"],"summary":"Patch a media retention policy","description":"","operationId":"patchRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/CrossPlatformPolicyUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:edit"]},"x-purecloud-method-name":"patchRecordingCrossplatformMediaretentionpolicy"}},"/api/v2/recording/mediaretentionpolicies":{"get":{"tags":["Recording"],"summary":"Gets media retention policy list with query options to filter on name and enabled.","description":"for a less verbose response, add summary=true to this endpoint","operationId":"getRecordingMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","description":"the policy name - used for filtering results in searches.","required":false,"type":"string"},{"name":"enabled","in":"query","description":"checks to see if policy is enabled - use enabled = true or enabled = false","required":false,"type":"boolean"},{"name":"summary","in":"query","description":"provides a less verbose response of policy lists.","required":false,"type":"boolean","default":false},{"name":"hasErrors","in":"query","description":"provides a way to fetch all policies with errors or policies that do not have errors","required":false,"type":"boolean"},{"name":"deleteDaysThreshold","in":"query","description":"provides a way to fetch all policies with any actions having deleteDays exceeding the provided value","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PolicyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:view"]},"x-purecloud-method-name":"getRecordingMediaretentionpolicies"},"post":{"tags":["Recording"],"summary":"Create media retention policy","description":"Policy does not work retroactively","operationId":"postRecordingMediaretentionpolicies","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/PolicyCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.policy.invalid":"The recording policy is invalid.","recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","constraint.validation":"%s","recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","recording.policy.name.duplicate.name":"Policy name already exists, cannot duplicate.","recording.policy.description.exceeds.limit":"Policy description exceeds size limit.","recording.policy.analytics.retention.violation":"Policy retention was violated.","recording.policy.assign.survey.sending.domain.does.not.exist":"Sending domain does not exist in the organization","recording.policy.name.exceeds.limit":"Policy named exceeds size limit.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:add"]},"x-purecloud-method-name":"postRecordingMediaretentionpolicies"},"delete":{"tags":["Recording"],"summary":"Delete media retention policies","description":"Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.","operationId":"deleteRecordingMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"ids","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingMediaretentionpolicies"}},"/api/v2/recording/mediaretentionpolicies/{policyId}":{"get":{"tags":["Recording"],"summary":"Get a media retention policy","description":"","operationId":"getRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:view"]},"x-purecloud-method-name":"getRecordingMediaretentionpolicy"},"put":{"tags":["Recording"],"summary":"Update a media retention policy","description":"Policy does not work retroactively","operationId":"putRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","constraint.validation":"%s","recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","recording.policy.name.required":"Recording policy named required.","recording.policy.assign.survey.sending.domain.does.not.exist":"Sending domain does not exist in the organization","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error updating policy.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:edit"]},"x-purecloud-method-name":"putRecordingMediaretentionpolicy"},"delete":{"tags":["Recording"],"summary":"Delete a media retention policy","description":"","operationId":"deleteRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.policy.not.found":"The supplied policy was not found or is invalid","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingMediaretentionpolicy"},"patch":{"tags":["Recording"],"summary":"Patch a media retention policy","description":"","operationId":"patchRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/PolicyUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:edit"]},"x-purecloud-method-name":"patchRecordingMediaretentionpolicy"}},"/api/v2/recording/recordingkeys":{"get":{"tags":["Recording"],"summary":"Get encryption key list","description":"","operationId":"getRecordingRecordingkeys","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKeyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingRecordingkeys"},"post":{"tags":["Recording"],"summary":"Create encryption key","description":"","operationId":"postRecordingRecordingkeys","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"postRecordingRecordingkeys"}},"/api/v2/recording/recordingkeys/rotationschedule":{"get":{"tags":["Recording"],"summary":"Get key rotation schedule","description":"","operationId":"getRecordingRecordingkeysRotationschedule","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeyRotationSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingRecordingkeysRotationschedule"},"put":{"tags":["Recording"],"summary":"Update key rotation schedule","description":"","operationId":"putRecordingRecordingkeysRotationschedule","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"KeyRotationSchedule","required":true,"schema":{"$ref":"#/definitions/KeyRotationSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeyRotationSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"putRecordingRecordingkeysRotationschedule"}},"/api/v2/recording/localkeys":{"post":{"tags":["Recording"],"summary":"create a local key management recording key","description":"","operationId":"postRecordingLocalkeys","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Local Encryption body","required":true,"schema":{"$ref":"#/definitions/LocalEncryptionKeyRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"postRecordingLocalkeys"}},"/api/v2/recording/keyconfigurations/{keyConfigurationId}":{"get":{"tags":["Recording"],"summary":"Get the encryption key configurations","description":"","operationId":"getRecordingKeyconfiguration","produces":["application/json"],"parameters":[{"name":"keyConfigurationId","in":"path","description":"Key Configurations Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingKeyconfiguration"},"put":{"tags":["Recording"],"summary":"Update the encryption key configurations","description":"","operationId":"putRecordingKeyconfiguration","produces":["application/json"],"parameters":[{"name":"keyConfigurationId","in":"path","description":"Key Configurations Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Encryption key configuration metadata","required":true,"schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"putRecordingKeyconfiguration"}},"/api/v2/recording/keyconfigurations":{"get":{"tags":["Recording"],"summary":"Get a list of key configurations data","description":"","operationId":"getRecordingKeyconfigurations","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingEncryptionConfigurationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingKeyconfigurations"},"post":{"tags":["Recording"],"summary":"Setup configurations for encryption key creation","description":"","operationId":"postRecordingKeyconfigurations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Encryption Configuration","required":true,"schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"postRecordingKeyconfigurations"}},"/api/v2/recording/keyconfigurations/validate":{"post":{"tags":["Recording"],"summary":"Validate encryption key configurations without saving it","description":"","operationId":"postRecordingKeyconfigurationsValidate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Encryption Configuration","required":true,"schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"postRecordingKeyconfigurationsValidate"}},"/api/v2/externalcontacts/bulk/contacts/remove":{"post":{"tags":["External Contacts"],"summary":"Bulk remove contacts","description":"","operationId":"postExternalcontactsBulkContactsRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contact ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkDeleteResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:delete"]},"x-purecloud-method-name":"postExternalcontactsBulkContactsRemove"}},"/api/v2/externalcontacts/bulk/contacts/add":{"post":{"tags":["External Contacts"],"summary":"Bulk add contacts","description":"","operationId":"postExternalcontactsBulkContactsAdd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contacts","required":true,"schema":{"$ref":"#/definitions/BulkContactsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkContactsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided contact list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:add"]},"x-purecloud-method-name":"postExternalcontactsBulkContactsAdd"}},"/api/v2/externalcontacts/bulk/contacts":{"post":{"tags":["External Contacts"],"summary":"Bulk fetch contacts","description":"","operationId":"postExternalcontactsBulkContacts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contact ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkFetchContactsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"postExternalcontactsBulkContacts"}},"/api/v2/externalcontacts/bulk/contacts/update":{"post":{"tags":["External Contacts"],"summary":"Bulk update contacts","description":"","operationId":"postExternalcontactsBulkContactsUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contacts","required":true,"schema":{"$ref":"#/definitions/BulkContactsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkContactsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided contact list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:edit"]},"x-purecloud-method-name":"postExternalcontactsBulkContactsUpdate"}},"/api/v2/externalcontacts/bulk/contacts/unresolved":{"post":{"tags":["External Contacts"],"summary":"Bulk fetch unresolved ancestor contacts","description":"","operationId":"postExternalcontactsBulkContactsUnresolved","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contact ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkFetchContactsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"postExternalcontactsBulkContactsUnresolved"}},"/api/v2/externalcontacts/bulk/notes/add":{"post":{"tags":["External Contacts"],"summary":"Bulk add notes","description":"","operationId":"postExternalcontactsBulkNotesAdd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Notes","required":true,"schema":{"$ref":"#/definitions/BulkNotesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkNotesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided note list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:add","externalContacts:externalOrganization:add"]},"x-purecloud-method-name":"postExternalcontactsBulkNotesAdd"}},"/api/v2/externalcontacts/bulk/notes/remove":{"post":{"tags":["External Contacts"],"summary":"Bulk remove notes","description":"","operationId":"postExternalcontactsBulkNotesRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Note ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkDeleteResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided note list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:delete","externalContacts:externalOrganization:delete"]},"x-purecloud-method-name":"postExternalcontactsBulkNotesRemove"}},"/api/v2/externalcontacts/bulk/notes":{"post":{"tags":["External Contacts"],"summary":"Bulk fetch notes","description":"","operationId":"postExternalcontactsBulkNotes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Note ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkFetchNotesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided note list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"postExternalcontactsBulkNotes"}},"/api/v2/externalcontacts/bulk/notes/update":{"post":{"tags":["External Contacts"],"summary":"Bulk update notes","description":"","operationId":"postExternalcontactsBulkNotesUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Notes","required":true,"schema":{"$ref":"#/definitions/BulkNotesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkNotesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided note list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsBulkNotesUpdate"}},"/api/v2/externalcontacts/bulk/organizations/add":{"post":{"tags":["External Contacts"],"summary":"Bulk add organizations","description":"","operationId":"postExternalcontactsBulkOrganizationsAdd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organizations","required":true,"schema":{"$ref":"#/definitions/BulkOrganizationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkOrganizationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided externalOrganization list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:add"]},"x-purecloud-method-name":"postExternalcontactsBulkOrganizationsAdd"}},"/api/v2/externalcontacts/bulk/organizations/remove":{"post":{"tags":["External Contacts"],"summary":"Bulk remove organizations","description":"","operationId":"postExternalcontactsBulkOrganizationsRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkDeleteResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided externalOrganization list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:delete"]},"x-purecloud-method-name":"postExternalcontactsBulkOrganizationsRemove"}},"/api/v2/externalcontacts/bulk/organizations":{"post":{"tags":["External Contacts"],"summary":"Bulk fetch organizations","description":"","operationId":"postExternalcontactsBulkOrganizations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organizations ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkFetchOrganizationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided externalOrganization list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"postExternalcontactsBulkOrganizations"}},"/api/v2/externalcontacts/bulk/organizations/update":{"post":{"tags":["External Contacts"],"summary":"Bulk update organizations","description":"","operationId":"postExternalcontactsBulkOrganizationsUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organizations","required":true,"schema":{"$ref":"#/definitions/BulkOrganizationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkOrganizationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided externalOrganization list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsBulkOrganizationsUpdate"}},"/api/v2/externalcontacts/bulk/relationships":{"post":{"tags":["External Contacts"],"summary":"Bulk fetch relationships","description":"","operationId":"postExternalcontactsBulkRelationships","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationships ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkFetchRelationshipsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided relationship list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"postExternalcontactsBulkRelationships"}},"/api/v2/externalcontacts/bulk/relationships/update":{"post":{"tags":["External Contacts"],"summary":"Bulk update relationships","description":"","operationId":"postExternalcontactsBulkRelationshipsUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationships","required":true,"schema":{"$ref":"#/definitions/BulkRelationshipsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkRelationshipsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided relationship list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsBulkRelationshipsUpdate"}},"/api/v2/externalcontacts/bulk/relationships/add":{"post":{"tags":["External Contacts"],"summary":"Bulk add relationships","description":"","operationId":"postExternalcontactsBulkRelationshipsAdd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationships","required":true,"schema":{"$ref":"#/definitions/BulkRelationshipsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkRelationshipsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided relationship list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:add","externalContacts:externalOrganization:add"]},"x-purecloud-method-name":"postExternalcontactsBulkRelationshipsAdd"}},"/api/v2/externalcontacts/bulk/relationships/remove":{"post":{"tags":["External Contacts"],"summary":"Bulk remove relationships","description":"","operationId":"postExternalcontactsBulkRelationshipsRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationships ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkDeleteResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided relationship list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:delete","externalContacts:externalOrganization:delete"]},"x-purecloud-method-name":"postExternalcontactsBulkRelationshipsRemove"}},"/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a note for an external contact","description":"","operationId":"getExternalcontactsContactNote","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContactNote"},"put":{"tags":["External Contacts"],"summary":"Update a note for an external contact","description":"","operationId":"putExternalcontactsContactNote","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Note","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:edit","externalContacts:contact:edit"]},"x-purecloud-method-name":"putExternalcontactsContactNote"},"delete":{"tags":["External Contacts"],"summary":"Delete a note for an external contact","description":"","operationId":"deleteExternalcontactsContactNote","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.division.id":"The specified division(s) is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:edit","externalContacts:contact:edit"]},"x-purecloud-method-name":"deleteExternalcontactsContactNote"}},"/api/v2/externalcontacts/contacts/{contactId}/notes":{"get":{"tags":["External Contacts"],"summary":"List notes for an external contact","description":"","operationId":"getExternalcontactsContactNotes","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"createDate:desc\"","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Contact is not found by contact id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContactNotes"},"post":{"tags":["External Contacts"],"summary":"Create a note for an external contact","description":"","operationId":"postExternalcontactsContactNotes","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Contact is not found by contact id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:edit","externalContacts:contact:edit"]},"x-purecloud-method-name":"postExternalcontactsContactNotes"}},"/api/v2/externalcontacts/contacts/{contactId}":{"get":{"tags":["External Contacts"],"summary":"Fetch an external contact","description":"","operationId":"getExternalcontactsContact","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources","identifiers"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContact"},"put":{"tags":["External Contacts"],"summary":"Update an external contact","description":"","operationId":"putExternalcontactsContact","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/ExternalContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:edit","externalContacts:contact:edit"]},"x-purecloud-method-name":"putExternalcontactsContact"},"delete":{"tags":["External Contacts"],"summary":"Delete an external contact","description":"","operationId":"deleteExternalcontactsContact","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.division.id":"The specified division(s) is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","contact.not.found":"Contact is not found by contact id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:delete","externalContacts:contact:delete"]},"x-purecloud-method-name":"deleteExternalcontactsContact"}},"/api/v2/externalcontacts/contacts/{contactId}/identifiers":{"get":{"tags":["External Contacts"],"summary":"List the identifiers for a contact","description":"","operationId":"getExternalcontactsContactIdentifiers","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","contact.not.found":"Contact is not found by contact id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContactIdentifiers"},"patch":{"tags":["External Contacts"],"summary":"Claim or release identifiers for a contact","description":"","operationId":"patchExternalcontactsContactIdentifiers","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ClaimRequest","required":true,"schema":{"$ref":"#/definitions/IdentifierClaimRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactIdentifier"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.operation.type":"Invalid operation type","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","identifier.cannot.be.released":"Identifier cannot be released because it is not claimed by the contact","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"identifier.claim.conflict":"Identifier is already claimed"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"identifier.cannot.be.claimed":"Identifier cannot be claimed as there's no empty field on the contact to place the identifier","operation.validation.failed":"Operation cannot take the value","validation.failed":"Field operation is not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:edit"]},"x-purecloud-method-name":"patchExternalcontactsContactIdentifiers"}},"/api/v2/externalcontacts/contacts/{contactId}/promotion":{"post":{"tags":["External Contacts"],"summary":"Promote an observed contact (ephemeral or identified) to a curated contact","description":"","operationId":"postExternalcontactsContactPromotion","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","promotion.of.curated.contact.failed":"The contact is a curated contact and cannot be promoted","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"The contact's type must be equal to \"Ephemeral\" or \"Identified\""}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:identity:promote"]},"x-purecloud-method-name":"postExternalcontactsContactPromotion"}},"/api/v2/externalcontacts/contacts/schemas/{schemaId}":{"get":{"tags":["External Contacts"],"summary":"Get a schema","description":"","operationId":"getExternalcontactsContactsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchema"},"put":{"tags":["External Contacts"],"summary":"Update a schema","description":"","operationId":"putExternalcontactsContactsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Data Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas cannot exceed 500.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax. Check that all required schema fields are present.","invalid.property":"Value [%s] is not a valid property for object [%s]","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","constraint.validation":"%s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields","dynamic.schema.validation.limit.error":"The JSON schema provided for update has a validation limit error.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The new JSON schema provided for update is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:edit"]},"x-purecloud-method-name":"putExternalcontactsContactsSchema"},"delete":{"tags":["External Contacts"],"summary":"Delete a schema","description":"","operationId":"deleteExternalcontactsContactsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"Delete operation forbidden.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:edit"]},"x-purecloud-method-name":"deleteExternalcontactsContactsSchema"}},"/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions/{versionId}":{"get":{"tags":["External Contacts"],"summary":"Get a specific version of a schema","description":"","operationId":"getExternalcontactsContactsSchemaVersion","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Schema version","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchemaVersion"}},"/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions":{"get":{"tags":["External Contacts"],"summary":"Get all versions of an external contact's schema","description":"","operationId":"getExternalcontactsContactsSchemaVersions","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchemaVersions"}},"/api/v2/externalcontacts/contacts/schemas":{"get":{"tags":["External Contacts"],"summary":"Get a list of schemas.","description":"","operationId":"getExternalcontactsContactsSchemas","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchemaListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchemas"},"post":{"tags":["External Contacts"],"summary":"Create a schema","description":"","operationId":"postExternalcontactsContactsSchemas","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas would exceed 500.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","constraint.validation":"%s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields","dynamic.schema.validation.limit.error":"The schema has a validation limit error.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The schema is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dynamic.schema.length.limits.would.be.exceeded":"The schema title should not exceed 50 characters. The schema description should not exceed 200 characters.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:add"]},"x-purecloud-method-name":"postExternalcontactsContactsSchemas"}},"/api/v2/externalcontacts/contacts":{"get":{"tags":["External Contacts"],"summary":"Search for external contacts","description":"","operationId":"getExternalcontactsContacts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"User supplied search keywords (no special syntax is currently supported)","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \"firstName:asc\", \"title:desc\"","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources","identifiers"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContacts"},"post":{"tags":["External Contacts"],"summary":"Create an external contact","description":"","operationId":"postExternalcontactsContacts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/ExternalContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:add","externalContacts:contact:add"]},"x-purecloud-method-name":"postExternalcontactsContacts"}},"/api/v2/externalcontacts/merge/contacts":{"post":{"tags":["External Contacts"],"summary":"Merge two contacts into a new contact record","description":"Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details","operationId":"postExternalcontactsMergeContacts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"MergeRequest","required":true,"schema":{"$ref":"#/definitions/MergeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"One of the contacts in the merge request was not found by ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"mergeset.max.size":"The number of merges exceeds the maximum size"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"User supplied an invalid merge request","merge.across.divisions.disallowed":"User supplied an invalid merge request"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:identity:merge"]},"x-purecloud-method-name":"postExternalcontactsMergeContacts"}},"/api/v2/externalcontacts/scan/contacts":{"get":{"tags":["External Contacts"],"summary":"Scan for external contacts using paging","description":"","operationId":"getExternalcontactsScanContacts","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of contacts per page; must be between 10 and 200, default is 100","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"User supplied an invalid entity or an invalid/expired cursor"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsScanContacts"}},"/api/v2/externalcontacts/conversations/{conversationId}":{"put":{"tags":["External Contacts"],"summary":"Associate/disassociate an external contact with a conversation","description":"To associate, supply a value for the externalContactId. To disassociate, do not include the property at all.","operationId":"putExternalcontactsConversation","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ConversationAssociation","required":true,"schema":{"$ref":"#/definitions/ConversationAssociation"}},{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing association"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The JSON body of the request was not valid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","eternal.contacts.invalid.entity.id":"The entity ID was invalid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.association.communication.id.required":"The communication id is required"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External contact is not found by conversation id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:conversation:associate","externalContacts:conversation:associate"]},"x-purecloud-method-name":"putExternalcontactsConversation"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts":{"get":{"tags":["External Contacts"],"summary":"Search for external contacts in an external organization","description":"","operationId":"getExternalcontactsOrganizationContacts","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"User supplied search keywords (no special syntax is currently supported)","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \"firstName:asc\", \"title:desc\"","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources","identifiers"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External Organization is not found by externalOrganizationId.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationContacts"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a note for an external organization","description":"","operationId":"getExternalcontactsOrganizationNote","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationNote"},"put":{"tags":["External Contacts"],"summary":"Update a note for an external organization","description":"","operationId":"putExternalcontactsOrganizationNote","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Note","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganizationNote"},"delete":{"tags":["External Contacts"],"summary":"Delete a note for an external organization","description":"","operationId":"deleteExternalcontactsOrganizationNote","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.division.id":"The specified division(s) is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"deleteExternalcontactsOrganizationNote"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes":{"get":{"tags":["External Contacts"],"summary":"List notes for an external organization","description":"","operationId":"getExternalcontactsOrganizationNotes","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"createDate:desc\"","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External Organization is not found by externalOrganizationId.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationNotes"},"post":{"tags":["External Contacts"],"summary":"Create a note for an external organization","description":"","operationId":"postExternalcontactsOrganizationNotes","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External Organization is not found by externalOrganizationId.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsOrganizationNotes"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships":{"get":{"tags":["External Contacts"],"summary":"Fetch a relationship for an external organization","description":"","operationId":"getExternalcontactsOrganizationRelationships","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalDataSources"]},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"The Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"relationship:desc\"","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RelationshipListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External Organization is not found by externalOrganizationId.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationRelationships"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}":{"get":{"tags":["External Contacts"],"summary":"Fetch an external organization","description":"","operationId":"getExternalcontactsOrganization","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand (externalDataSources)","required":false,"type":"array","items":{"type":"string","enum":["externalDataSources"]},"collectionFormat":"multi"},{"name":"includeTrustors","in":"query","description":"(true or false) whether or not to include trustor information embedded in the externalOrganization","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External organization is not found by external organization id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganization"},"put":{"tags":["External Contacts"],"summary":"Update an external organization","description":"","operationId":"putExternalcontactsOrganization","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalOrganization","required":true,"schema":{"$ref":"#/definitions/ExternalOrganization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External organization is not found by external organization id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganization"},"delete":{"tags":["External Contacts"],"summary":"Delete an external organization","description":"","operationId":"deleteExternalcontactsOrganization","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.division.id":"The specified division(s) is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External organization is not found by external organization id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:delete","externalContacts:externalOrganization:delete"]},"x-purecloud-method-name":"deleteExternalcontactsOrganization"}},"/api/v2/externalcontacts/organizations/schemas/{schemaId}":{"get":{"tags":["External Contacts"],"summary":"Get a schema","description":"","operationId":"getExternalcontactsOrganizationsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchema"},"put":{"tags":["External Contacts"],"summary":"Update a schema","description":"","operationId":"putExternalcontactsOrganizationsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Data Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas cannot exceed 500.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","constraint.validation":"%s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields","dynamic.schema.validation.limit.error":"The new JSON schema provided for update has a validation limit error.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The new JSON schema provided for update is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganizationsSchema"}},"/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions/{versionId}":{"get":{"tags":["External Contacts"],"summary":"Get a specific version of a schema","description":"","operationId":"getExternalcontactsOrganizationsSchemaVersion","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Schema version","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchemaVersion"}},"/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions":{"get":{"tags":["External Contacts"],"summary":"Get all versions of an external organization's schema","description":"","operationId":"getExternalcontactsOrganizationsSchemaVersions","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchemaVersions"}},"/api/v2/externalcontacts/organizations/schemas":{"get":{"tags":["External Contacts"],"summary":"Get a list of schemas.","description":"","operationId":"getExternalcontactsOrganizationsSchemas","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchemaListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchemas"},"post":{"tags":["External Contacts"],"summary":"Create a schema","description":"","operationId":"postExternalcontactsOrganizationsSchemas","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas cannot exceed 500.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","constraint.validation":"%s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields","dynamic.schema.validation.limit.error":"The new JSON schema provided for update has a validation limit error.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The new JSON schema provided for update is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:add"]},"x-purecloud-method-name":"postExternalcontactsOrganizationsSchemas"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId}":{"put":{"tags":["External Contacts"],"summary":"Links a Trustor with an External Organization","description":"","operationId":"putExternalcontactsOrganizationTrustorTrustorId","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"trustorId","in":"path","description":"Trustor ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganizationTrustorLink"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Trustor is not found by trustor id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"Provided fields are not valid."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganizationTrustorTrustorId"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor":{"delete":{"tags":["External Contacts"],"summary":"Unlink the Trustor for this External Organization","description":"","operationId":"deleteExternalcontactsOrganizationTrustor","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"}],"responses":{"204":{"description":"Trustor link has been deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.division.id":"The specified division(s) is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Organization is not found by organization id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"deleteExternalcontactsOrganizationTrustor"}},"/api/v2/externalcontacts/organizations":{"get":{"tags":["External Contacts"],"summary":"Search for external organizations","description":"","operationId":"getExternalcontactsOrganizations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"Search query","required":false,"type":"string"},{"name":"trustorId","in":"query","description":"Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. \"companyType:asc\", \"industry:desc\"","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalDataSources"]},"collectionFormat":"multi"},{"name":"includeTrustors","in":"query","description":"(true or false) whether or not to include trustor information embedded in the externalOrganization","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganizationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizations"},"post":{"tags":["External Contacts"],"summary":"Create an external organization","description":"","operationId":"postExternalcontactsOrganizations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExternalOrganization","required":true,"schema":{"$ref":"#/definitions/ExternalOrganization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The provided custom field is not valid.","validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:add","externalContacts:externalOrganization:add"]},"x-purecloud-method-name":"postExternalcontactsOrganizations"}},"/api/v2/externalcontacts/scan/organizations":{"get":{"tags":["External Contacts"],"summary":"Scan for external organizations using paging","description":"","operationId":"getExternalcontactsScanOrganizations","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of organizations per page; must be between 10 and 200, default is 100","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorOrganizationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"User supplied an invalid entity or an invalid/expired cursor"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsScanOrganizations"}},"/api/v2/externalcontacts/identifierlookup":{"post":{"tags":["External Contacts"],"summary":"Fetch a contact using an identifier type and value.","description":"Phone number identifier values must be provided with the country code and a leading '+' symbol. Example: \"+1 704 298 4733\"","operationId":"postExternalcontactsIdentifierlookup","produces":["application/json"],"parameters":[{"in":"body","name":"identifier","required":true,"schema":{"$ref":"#/definitions/ContactIdentifier"}},{"name":"expand","in":"query","description":"which field, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","identifiers"]},"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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided identifier is not valid."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view","relate:contact:view"]},"x-purecloud-method-name":"postExternalcontactsIdentifierlookup"}},"/api/v2/externalcontacts/contacts/{contactId}/journey/sessions":{"get":{"tags":["External Contacts","Journey"],"summary":"Retrieve all sessions for a given external contact.","description":"","operationId":"getExternalcontactsContactJourneySessions","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"includeMerged","in":"query","description":"Indicates whether to return sessions from all external contacts in the merge-set of the given one.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SessionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:session:view"]},"x-purecloud-method-name":"getExternalcontactsContactJourneySessions"}},"/api/v2/externalcontacts/scan/notes":{"get":{"tags":["External Contacts"],"summary":"Scan for notes using paging","description":"","operationId":"getExternalcontactsScanNotes","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of notes per page; must be between 10 and 200, default is 100","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorNoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"User supplied an invalid entity or an invalid/expired cursor"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsScanNotes"}},"/api/v2/externalcontacts/relationships/{relationshipId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a relationship","description":"","operationId":"getExternalcontactsRelationship","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Relationship is not found by relationship id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsRelationship"},"put":{"tags":["External Contacts"],"summary":"Update a relationship","description":"","operationId":"putExternalcontactsRelationship","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Relationship","required":true,"schema":{"$ref":"#/definitions/Relationship"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Relationship is not found by relationship id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsRelationship"},"delete":{"tags":["External Contacts"],"summary":"Delete a relationship","description":"","operationId":"deleteExternalcontactsRelationship","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.division.id":"The specified division(s) is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Relationship is not found by relationship id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"deleteExternalcontactsRelationship"}},"/api/v2/externalcontacts/relationships":{"post":{"tags":["External Contacts"],"summary":"Create a relationship","description":"","operationId":"postExternalcontactsRelationships","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationship","required":true,"schema":{"$ref":"#/definitions/Relationship"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"The provided external organization was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsRelationships"}},"/api/v2/externalcontacts/scan/relationships":{"get":{"tags":["External Contacts"],"summary":"Scan for relationships","description":"","operationId":"getExternalcontactsScanRelationships","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of relationships per page; must be between 10 and 200, default is 100","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorRelationshipListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"User supplied an invalid entity or an invalid/expired cursor"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsScanRelationships"}},"/api/v2/externalcontacts/reversewhitepageslookup":{"get":{"tags":["External Contacts"],"summary":"Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.","description":"","operationId":"getExternalcontactsReversewhitepageslookup","produces":["application/json"],"parameters":[{"name":"lookupVal","in":"query","description":"User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)","required":true,"type":"string"},{"name":"expand","in":"query","description":"which field, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["contacts.externalOrganization","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReverseWhitepagesLookupResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsReversewhitepageslookup"}},"/api/v2/externalcontacts/contacts/{contactId}/unresolved":{"get":{"tags":["External Contacts"],"summary":"Fetch an unresolved external contact","description":"","operationId":"getExternalcontactsContactUnresolved","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources","identifiers"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContactUnresolved"}},"/api/v2/contentmanagement/documents/{documentId}/content":{"get":{"tags":["Content Management"],"summary":"Download a document.","description":"","operationId":"getContentmanagementDocumentContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"disposition","in":"query","description":"Request how the content will be downloaded: a file attachment or inline. Default is attachment.","required":false,"type":"string","enum":["attachment","inline"]},{"name":"contentType","in":"query","description":"The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav","required":false,"type":"string"}],"responses":{"200":{"description":"Download location returned","schema":{"$ref":"#/definitions/DownloadResponse"}},"202":{"description":"Accepted - Preparing file for download - try again soon."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from downloading content.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementDocumentContent"},"post":{"tags":["Content Management"],"summary":"Replace the contents of a document.","description":"","operationId":"postContentmanagementDocumentContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Replace Request","required":true,"schema":{"$ref":"#/definitions/ReplaceRequest"}},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"202":{"description":"Accepted - Ready for upload","schema":{"$ref":"#/definitions/ReplaceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.null.argument":"Invalid request, null argument provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected changeNumber was provided","x-inin-error-codes":{"resource.conflict":"Resource conflict - Unexpected changeNumber was provided."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation","x-inin-error-codes":{"locked":"Locked - The document is locked by another operation."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementDocumentContent"}},"/api/v2/contentmanagement/documents/{documentId}":{"get":{"tags":["Content Management"],"summary":"Get a document.","description":"","operationId":"getContentmanagementDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["lockInfo","acl","workspace"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"forbidden":"Forbidden from getting document","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementDocument"},"post":{"tags":["Content Management"],"summary":"Update a document.","description":"","operationId":"postContentmanagementDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Document","required":true,"schema":{"$ref":"#/definitions/DocumentUpdate"}},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl"]},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected changeNumber was provided"},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementDocument"},"delete":{"tags":["Content Management"],"summary":"Delete a document.","description":"","operationId":"deleteContentmanagementDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementDocument"}},"/api/v2/contentmanagement/documents":{"get":{"tags":["Content Management"],"summary":"Get a list of documents.","description":"","operationId":"getContentmanagementDocuments","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"query","description":"Workspace ID","required":true,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl","workspace"]},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getContentmanagementDocuments"},"post":{"tags":["Content Management"],"summary":"Add a document.","description":"","operationId":"postContentmanagementDocuments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Document","required":true,"schema":{"$ref":"#/definitions/DocumentUpload"}},{"name":"copySource","in":"query","description":"Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source.","required":false,"type":"string"},{"name":"moveSource","in":"query","description":"Move a document to a new workspace. Provide a document ID as the move source.","required":false,"type":"string"},{"name":"override","in":"query","description":"Override any lock on the source document","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.null.argument":"Invalid, null arguments provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from adding a document.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The source document is locked by another operation"},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementDocuments"}},"/api/v2/contentmanagement/query":{"get":{"tags":["Content Management"],"summary":"Query content","description":"","operationId":"getContentmanagementQuery","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"},{"name":"queryPhrase","in":"query","description":"Phrase tokens are ANDed together over all searchable fields","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl","workspace"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementQuery"},"post":{"tags":["Content Management"],"summary":"Query content","description":"","operationId":"postContentmanagementQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Allows for a filtered query returning facet information","required":true,"schema":{"$ref":"#/definitions/QueryRequest"}},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl","workspace"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","trustee.forbidden":"Forbidden due to trustee from deleting query content.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from deleting query content.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"postContentmanagementQuery"}},"/api/v2/contentmanagement/securityprofiles/{securityProfileId}":{"get":{"tags":["Content Management"],"summary":"Get a Security Profile","description":"","operationId":"getContentmanagementSecurityprofile","produces":["application/json"],"parameters":[{"name":"securityProfileId","in":"path","description":"Security Profile Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecurityProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementSecurityprofile"}},"/api/v2/contentmanagement/securityprofiles":{"get":{"tags":["Content Management"],"summary":"Get a List of Security Profiles","description":"","operationId":"getContentmanagementSecurityprofiles","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecurityProfileEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementSecurityprofiles"}},"/api/v2/contentmanagement/shares/{shareId}":{"get":{"tags":["Content Management"],"summary":"Retrieve details about an existing share.","description":"","operationId":"getContentmanagementShare","produces":["application/json"],"parameters":[{"name":"shareId","in":"path","description":"Share ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Share"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementShare"},"delete":{"tags":["Content Management"],"summary":"Deletes an existing share.","description":"This revokes sharing rights specified in the share record","operationId":"deleteContentmanagementShare","produces":["application/json"],"parameters":[{"name":"shareId","in":"path","description":"Share ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from deleting a share.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementShare"}},"/api/v2/contentmanagement/shared/{sharedId}":{"get":{"tags":["Content Management"],"summary":"Get shared documents. Securely download a shared document.","description":"This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.","operationId":"getContentmanagementSharedSharedId","produces":["application/json"],"parameters":[{"name":"sharedId","in":"path","description":"Shared ID","required":true,"type":"string"},{"name":"redirect","in":"query","description":"Turn on or off redirect","required":false,"type":"boolean","default":true},{"name":"disposition","in":"query","description":"Request how the share content will be downloaded: attached as a file or inline. Default is attachment.","required":false,"type":"string","default":"attachment","enum":["attachment","inline","none"]},{"name":"contentType","in":"query","description":"The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["document.acl"]}],"responses":{"200":{"description":"Download location is returned in header, if redirect is set to false and disposition is not set to none. If disposition is none, location header will not be populated, DownloadUri and ViewUri will be populated.","schema":{"$ref":"#/definitions/SharedResponse"}},"202":{"description":"Accepted - Preparing file for download - try again soon."},"307":{"description":"Redirected to download location, if redirect is set to true"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","unauthorized":"Unauthorized to access document.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Unable to access document.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementSharedSharedId"}},"/api/v2/contentmanagement/shares":{"get":{"tags":["Content Management"],"summary":"Gets a list of shares. You must specify at least one filter (e.g. entityId).","description":"Failing to specify a filter will return 400.","operationId":"getContentmanagementShares","produces":["application/json"],"parameters":[{"name":"entityId","in":"query","description":"Filters the shares returned to only the entity specified by the value of this parameter.","required":false,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShareEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementShares"},"post":{"tags":["Content Management"],"summary":"Creates a new share or updates an existing share if the entity has already been shared","description":"","operationId":"postContentmanagementShares","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CreateShareRequest - entity id and type and a single member or list of members are required","required":true,"schema":{"$ref":"#/definitions/CreateShareRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateShareResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"forbidden":"Forbidden from saving a share.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementShares"}},"/api/v2/contentmanagement/status/{statusId}":{"get":{"tags":["Content Management"],"summary":"Get a status.","description":"","operationId":"getContentmanagementStatusStatusId","produces":["application/json"],"parameters":[{"name":"statusId","in":"path","description":"Status ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommandStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementStatusStatusId"},"delete":{"tags":["Content Management"],"summary":"Cancel the command for this status","description":"","operationId":"deleteContentmanagementStatusStatusId","produces":["application/json"],"parameters":[{"name":"statusId","in":"path","description":"Status ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementStatusStatusId"}},"/api/v2/contentmanagement/status":{"get":{"tags":["Content Management"],"summary":"Get a list of statuses for pending operations","description":"","operationId":"getContentmanagementStatus","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommandStatusEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementStatus"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace tag","description":"","operationId":"getContentmanagementWorkspaceTagvalue","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceTagvalue"},"put":{"tags":["Content Management"],"summary":"Update a workspace tag. Will update all documents with the new tag value.","description":"","operationId":"putContentmanagementWorkspaceTagvalue","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace","required":true,"schema":{"$ref":"#/definitions/TagValue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"202":{"description":"Accepted - Processing Update"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"tag.value.too.long":"The tag value is too long.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","tag.value.empty":"The tag value cannot be empty.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"putContentmanagementWorkspaceTagvalue"},"delete":{"tags":["Content Management"],"summary":"Delete workspace tag","description":"Delete a tag from a workspace. Will remove this tag from all documents.","operationId":"deleteContentmanagementWorkspaceTagvalue","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementWorkspaceTagvalue"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query":{"post":{"tags":["Content Management"],"summary":"Perform a prefix query on tags in the workspace","description":"","operationId":"postContentmanagementWorkspaceTagvaluesQuery","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TagQueryRequest"}},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"postContentmanagementWorkspaceTagvaluesQuery"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues":{"get":{"tags":["Content Management"],"summary":"Get a list of workspace tags","description":"","operationId":"getContentmanagementWorkspaceTagvalues","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"value","in":"query","description":"filter the list of tags returned","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceTagvalues"},"post":{"tags":["Content Management"],"summary":"Create a workspace tag","description":"","operationId":"postContentmanagementWorkspaceTagvalues","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"tag","required":true,"schema":{"$ref":"#/definitions/TagValue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementWorkspaceTagvalues"}},"/api/v2/contentmanagement/usage":{"get":{"tags":["Content Management"],"summary":"Get usage details.","description":"","operationId":"getContentmanagementUsage","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Usage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementUsage"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/documents":{"get":{"tags":["Content Management"],"summary":"Get a list of documents.","description":"","operationId":"getContentmanagementWorkspaceDocuments","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl","workspace"]},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceDocuments"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace member","description":"","operationId":"getContentmanagementWorkspaceMember","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to get a member from a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceMember"},"put":{"tags":["Content Management"],"summary":"Add a member to a workspace","description":"","operationId":"putContentmanagementWorkspaceMember","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace Member","required":true,"schema":{"$ref":"#/definitions/WorkspaceMember"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to add a member to a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"putContentmanagementWorkspaceMember"},"delete":{"tags":["Content Management"],"summary":"Delete a member from a workspace","description":"","operationId":"deleteContentmanagementWorkspaceMember","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to delete a member from a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementWorkspaceMember"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/members":{"get":{"tags":["Content Management"],"summary":"Get a list workspace members","description":"","operationId":"getContentmanagementWorkspaceMembers","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to get workspace members","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceMembers"}},"/api/v2/contentmanagement/workspaces/{workspaceId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace.","description":"","operationId":"getContentmanagementWorkspace","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["summary","acl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from getting a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspace"},"put":{"tags":["Content Management"],"summary":"Update a workspace","description":"","operationId":"putContentmanagementWorkspace","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace","required":true,"schema":{"$ref":"#/definitions/Workspace"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to update a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"putContentmanagementWorkspace"},"delete":{"tags":["Content Management"],"summary":"Delete a workspace","description":"","operationId":"deleteContentmanagementWorkspace","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"moveChildrenToWorkspaceId","in":"query","description":"New location for objects in deleted workspace.","required":false,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from deleting a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementWorkspace"}},"/api/v2/contentmanagement/workspaces":{"get":{"tags":["Content Management"],"summary":"Get a list of workspaces.","description":"Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.","operationId":"getContentmanagementWorkspaces","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"access","in":"query","description":"Requested access level.","required":false,"type":"array","items":{"type":"string","enum":["content","admin","document:create","document:viewContent","document:viewMetadata","document:download","document:delete","document:update","document:share","document:shareView","document:email","document:print","document:auditView","document:replace","document:tag","tag:create","tag:view","tag:update","tag:apply","tag:remove","tag:delete"],"default":"document:viewmetadata"},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["summary","acl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.workspace.access.fields":"Has invalid workspace fields.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaces"},"post":{"tags":["Content Management"],"summary":"Create a group workspace","description":"","operationId":"postContentmanagementWorkspaces","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Workspace","required":true,"schema":{"$ref":"#/definitions/WorkspaceCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to create a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementWorkspaces"}},"/api/v2/conversations/participants/attributes/search":{"post":{"tags":["Conversations","Search"],"summary":"Search conversations","description":"","operationId":"postConversationsParticipantsAttributesSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/ConversationParticipantSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonCursorSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","access.denied":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:attributesview"]},"x-purecloud-method-name":"postConversationsParticipantsAttributesSearch"}},"/api/v2/conversations/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get conversation","description":"","operationId":"getConversation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:view"]},"x-purecloud-method-name":"getConversation"}},"/api/v2/conversations/{conversationId}/disconnect":{"post":{"tags":["Conversations"],"summary":"Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.","description":"","operationId":"postConversationDisconnect","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"postConversationDisconnect"}},"/api/v2/conversations/{conversationId}/assign":{"post":{"tags":["Conversations"],"summary":"Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages.","description":"","operationId":"postConversationAssign","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Targeted user","required":true,"schema":{"$ref":"#/definitions/ConversationUser"}}],"responses":{"202":{"description":"The manual assignment request was accepted","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.status":"The user's current routing status does not allow for new conversation assignments.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","feature.not.enabled":"The feature allowing manual assignment is not enabled for this queue.","operation.failed":"The manual assignment attempt failed.","invalid.id":"The targeted user ID is missing or invalid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"You do not have the required permission for this operation.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The conversation or queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Too many active requests. Try again later."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:pull","conversation:call:assign","conversation:callback:pull","conversation:callback:assign","conversation:webchat:pull","conversation:webchat:assign","conversation:email:pull","conversation:email:assign","conversation:message:pull","conversation:message:assign"]},"x-purecloud-method-name":"postConversationAssign"}},"/api/v2/conversations/{conversationId}/tags":{"put":{"tags":["Conversations"],"summary":"Update the tags on a conversation.","description":"","operationId":"putConversationTags","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation Tags","required":true,"schema":{"$ref":"#/definitions/ConversationTagsUpdate"}}],"responses":{"202":{"description":"The tags update request was accepted.","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:externalTag:edit"]},"x-purecloud-method-name":"putConversationTags"}},"/api/v2/conversations/{conversationId}/barge":{"post":{"tags":["Conversations"],"summary":"Barge a conversation creating a barged in conference of connected participants.","description":"","operationId":"postConversationBarge","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:barge"]},"x-purecloud-method-name":"postConversationBarge"}},"/api/v2/conversations/{conversationId}/secureattributes":{"get":{"tags":["Conversations"],"summary":"Get the secure attributes on a conversation.","description":"","operationId":"getConversationSecureattributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"Secure attributes retrieved successfully","schema":{"$ref":"#/definitions/ConversationSecureAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","secure.attributes.not.found":"Secure attributes could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:attributesview"]},"x-purecloud-method-name":"getConversationSecureattributes"},"put":{"tags":["Conversations"],"summary":"Set the secure attributes on a conversation.","description":"","operationId":"putConversationSecureattributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation Secure Attributes","required":true,"schema":{"$ref":"#/definitions/ConversationSecureAttributes"}}],"responses":{"202":{"description":"The secure attributes set request was accepted.","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.secure.attribute.conflict":"A conflict occurred setting the secure attributes."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:attributesedit"]},"x-purecloud-method-name":"putConversationSecureattributes"},"patch":{"tags":["Conversations"],"summary":"Update the secure attributes on a conversation.","description":"","operationId":"patchConversationSecureattributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation Secure Attributes","required":true,"schema":{"$ref":"#/definitions/ConversationSecureAttributes"}}],"responses":{"202":{"description":"The secure attributes update request was accepted.","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.secure.attribute.conflict":"A conflict occurred updating the secure attributes."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:attributesedit"]},"x-purecloud-method-name":"patchConversationSecureattributes"}},"/api/v2/conversations":{"get":{"tags":["Conversations"],"summary":"Get active conversations for the logged in user","description":"","operationId":"getConversations","produces":["application/json"],"parameters":[{"name":"communicationType","in":"query","description":"Call or Chat communication filtering","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversations"}},"/api/v2/conversations/faxes":{"post":{"tags":["Conversations"],"summary":"Create Fax Conversation","description":"","operationId":"postConversationsFaxes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Fax","required":true,"schema":{"$ref":"#/definitions/FaxSendRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSendResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fax.content.type.not.supported":"The fax content type is not supported.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","fax.missing.field":"Missing required field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fax.forbidden":"You are not permitted to send faxes.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","fax.internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsFaxes"}},"/api/v2/conversations/settings":{"get":{"tags":["Conversations"],"summary":"Get Settings","description":"","operationId":"getConversationsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Settings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:settings:view"]},"x-purecloud-method-name":"getConversationsSettings"},"patch":{"tags":["Conversations"],"summary":"Update Settings","description":"","operationId":"patchConversationsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Settings","required":true,"schema":{"$ref":"#/definitions/Settings"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:settings:edit"]},"x-purecloud-method-name":"patchConversationsSettings"}},"/api/v2/conversations/aftercallwork/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update after-call work for this conversation communication.","description":"","operationId":"patchConversationsAftercallworkConversationIdParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"AfterCallWorkUpdate","required":true,"schema":{"$ref":"#/definitions/AfterCallWorkUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AfterCallWorkUpdate"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/AfterCallWorkUpdate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsAftercallworkConversationIdParticipantCommunication"}},"/api/v2/conversations/callbacks/bulk/update":{"post":{"tags":["Conversations"],"summary":"Update multiple scheduled callbacks","description":"","operationId":"postConversationsCallbacksBulkUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"BulkCallbackPatchRequest","required":true,"schema":{"$ref":"#/definitions/BulkCallbackPatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkCallbackPatchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","callback.error.too.many.entities":"There were too many entities in the bulk edit request.","invalid.property":"Value [%s] is not a valid property for object [%s]","callback.error.scheduled.time.too.far.in.future":"Callback is scheduled to far in the future.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:callback:edit"]},"x-purecloud-method-name":"postConversationsCallbacksBulkUpdate"}},"/api/v2/conversations/callbacks/bulk/disconnect":{"post":{"tags":["Conversations"],"summary":"Disconnect multiple scheduled callbacks","description":"","operationId":"postConversationsCallbacksBulkDisconnect","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"BulkCallbackDisconnectRequest","required":true,"schema":{"$ref":"#/definitions/BulkCallbackDisconnectRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","callback.error.too.many.entities":"There were too many entities in the bulk disconnect request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"postConversationsCallbacksBulkDisconnect"}},"/api/v2/conversations/calls":{"get":{"tags":["Conversations"],"summary":"Get active call conversations for the logged in user","description":"","operationId":"getConversationsCalls","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCalls"},"post":{"tags":["Conversations"],"summary":"Create a call conversation","description":"","operationId":"postConversationsCalls","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Call request","required":true,"schema":{"$ref":"#/definitions/CreateCallRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateCallResponse"}},"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":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.cannot.resolve":"Cannot resolve station.","providerapi.error.user.does.not.have.a.station":"User does not have a station.","conversation.error.media.failed":"The media request failed.","providerapi.error.edge.cannot.resolve":"Cannot resolve edge.","providerapi.error.ccxml.uri.not_found":"Failed to get CCXML URI from edge config.","providerapi.error.edge.no.active":"Could not find an active Edge in Site.","providerapi.error.phone.cannot.resolve":"Cannot resolve phone.","providerapi.error.phone.no.active.edge":"The phone is not assigned to active Edges."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","providerapi.error.no.station.for.edge":"Station assignment for station found, but no primary or secondary Edge id was assigned to it."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:conference:add"]},"x-purecloud-method-name":"postConversationsCalls"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsCallParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","constraint.validation":"%s","callback.error.transfer.not.connected":"Only connected participants can be transferred.","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationsCallParticipantReplace"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult":{"post":{"tags":["Conversations"],"summary":"Initiate and update consult transfer","description":"","operationId":"postConversationsCallParticipantConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Destination address & initial speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransfer"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.consult.transfer.no.initiator":"The transfer request has no initiator.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","object.participant.id.required":"A connected object participant is required.","constraint.validation":"%s","conversation.error.consult.transfer.no.destination":"The transfer request has no destination.","conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","conversation.error.cannot.transfer.conference":"Performing a consult transfer on a conference is not allowed.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","not.a.participant":"You are not a connected participant on the call","dest.address.not.specified":"The destination address was not specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:consultTransfer"]},"x-purecloud-method-name":"postConversationsCallParticipantConsult"},"delete":{"tags":["Conversations"],"summary":"Cancel the transfer","description":"","operationId":"deleteConversationsCallParticipantConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversation.error.consult.transfer.not.started":"The consult transfer can't be canceled since it hasn't started yet."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationsCallParticipantConsult"},"patch":{"tags":["Conversations"],"summary":"Change who can speak","description":"","operationId":"patchConversationsCallParticipantConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"new speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransferUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","object.participant.id.required":"A connected object participant is required.","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","not.a.participant":"You are not a connected participant on the call","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallParticipantConsult"}},"/api/v2/conversations/calls/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get call conversation","description":"","operationId":"getConversationsCall","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.common.user":"This conference can not be created because there is no common user among all the active participants.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.media.failed":"The media request failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","providerapi.error.no.station.for.edge":"Station assignment for station found, but no primary or secondary Edge id was assigned to it."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCall"},"post":{"tags":["Conversations"],"summary":"Place a new call as part of a callback conversation.","description":"","operationId":"postConversationsCall","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/CallCommand"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversation.error.callback.call.cannot.be.placed":"An error occurred while trying to place the callback.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"The participant has no active conversation."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","providerapi.error.no.station.for.edge":"Station assignment for station found, but no primary or secondary Edge id was assigned to it."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsCall"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants","description":"","operationId":"patchConversationsCall","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.empty.conversation.list":"An empty list of conversations is invalid.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.cannot.merge.alerting.conference":"A conference cannot be created from an alerting call.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversation.error.call.disconnected":"Call is disconnected, cannot alter recordingState","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsCall"}},"/api/v2/conversations/calls/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsCallRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsCallRecordingstate"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsCallParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ParticipantAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallParticipantAttributes"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsCallParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallParticipantWrapup"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsCallParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallParticipantCommunication"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsCallParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsCallParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsCallParticipantCommunicationWrapup"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsCallParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversation.error.call.disconnected":"The call is already disconnected.","conversation.error.user.not.party":"The participant for this request does not belong to the user making the request.","constraint.validation":"%s","conversation.error.wrapup.cannot.skip":"Wrap-up cannot be skipped for this participant.","conversation.error.participant.no.active.conversations":"The participant has no active conversation.","conversation.error.hold.alerting":"An alerting call cannot be placed on hold.","conversation.error.cannot.create.conference":"Unable to create a conference.","conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","callback.error.answer.not.alerting":"Only alerting calls can be answered.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.cannot.confine.party":"The participant for this request cannot be confined.","conversation.error.wrapup.code.required":"Wrapup code is a required field and cannot be empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"Conversation not found.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsCallParticipant"}},"/api/v2/conversations/calls/maximumconferenceparties":{"get":{"tags":["Conversations"],"summary":"Get the maximum number of participants that this user can have on a conference","description":"","operationId":"getConversationsCallsMaximumconferenceparties","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MaxParticipants"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallsMaximumconferenceparties"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/coach":{"post":{"tags":["Conversations"],"summary":"Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.","description":"","operationId":"postConversationsCallParticipantCoach","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:coach"]},"x-purecloud-method-name":"postConversationsCallParticipantCoach"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/barge":{"post":{"tags":["Conversations"],"summary":"Barge a given participant's call creating a barged in conference of connected participants.","description":"","operationId":"postConversationsCallParticipantBarge","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.barge.not.consult.initiator":"A user cannot barge a consult transfer party that is not the initiator.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.multiple.barges":"A user cannot barge a participant that is already being barged.","conversation.error.barge.conference":"A participant cannot be barged when conversation is a conference.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:barge"]},"x-purecloud-method-name":"postConversationsCallParticipantBarge"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/agent":{"post":{"tags":["Conversations"],"summary":"Initiate a consult transfer to an agent","description":"","operationId":"postConversationsCallParticipantConsultAgent","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Destination agent & initial speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransferToAgent"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.consult.transfer.no.initiator":"The transfer request has no initiator.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","object.participant.id.required":"A connected object participant is required.","constraint.validation":"%s","conversation.error.consult.transfer.no.destination":"The transfer request has no destination.","conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","conversation.error.cannot.transfer.conference":"Performing a consult transfer on a conference is not allowed.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","not.a.participant":"You are not a connected participant on the call","dest.address.not.specified":"The destination address was not specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:consultTransfer","conversation:communication:consultTransferAgent"]},"x-purecloud-method-name":"postConversationsCallParticipantConsultAgent"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/queue":{"post":{"tags":["Conversations"],"summary":"Initiate a consult transfer to a queue","description":"","operationId":"postConversationsCallParticipantConsultQueue","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Destination queue & initial speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransferToQueue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.consult.transfer.no.initiator":"The transfer request has no initiator.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","object.participant.id.required":"A connected object participant is required.","constraint.validation":"%s","conversation.error.consult.transfer.no.destination":"The transfer request has no destination.","conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","conversation.error.cannot.transfer.conference":"Performing a consult transfer on a conference is not allowed.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","not.a.participant":"You are not a connected participant on the call","dest.address.not.specified":"The destination address was not specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:consultTransfer","conversation:communication:consultTransferQueue"]},"x-purecloud-method-name":"postConversationsCallParticipantConsultQueue"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/external":{"post":{"tags":["Conversations"],"summary":"Initiate a consult transfer to an external contact","description":"","operationId":"postConversationsCallParticipantConsultExternal","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Destination address & initial speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransferToExternal"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.consult.transfer.no.initiator":"The transfer request has no initiator.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","object.participant.id.required":"A connected object participant is required.","constraint.validation":"%s","conversation.error.consult.transfer.no.destination":"The transfer request has no destination.","conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","conversation.error.cannot.transfer.conference":"Performing a consult transfer on a conference is not allowed.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","not.a.participant":"You are not a connected participant on the call","dest.address.not.specified":"The destination address was not specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:consultTransfer","conversation:communication:consultTransferExternal"]},"x-purecloud-method-name":"postConversationsCallParticipantConsultExternal"}},"/api/v2/conversations/calls/{conversationId}/participants":{"post":{"tags":["Conversations"],"summary":"Add participants to a conversation","description":"","operationId":"postConversationsCallParticipants","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.cannot.merge.alerting.conference":"A conference cannot be created from an alerting call.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsCallParticipants"}},"/api/v2/conversations/calls/history":{"get":{"tags":["Conversations"],"summary":"Get call history","description":"","operationId":"getConversationsCallsHistory","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size, maximum 50","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"interval","in":"query","description":"Interval string; format is ISO-8601. Separate start and end times with forward slash '/'","required":false,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["externalorganization","externalcontact","user","queue","group"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallHistoryConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallsHistory"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/uuidata":{"put":{"tags":["Conversations"],"summary":"Set uuiData to be sent on future commands.","description":"","operationId":"putConversationsCallParticipantCommunicationUuidata","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"UUIData Request","required":true,"schema":{"$ref":"#/definitions/SetUuiDataRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"putConversationsCallParticipantCommunicationUuidata"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/monitor":{"post":{"tags":["Conversations"],"summary":"Listen in on the conversation from the point of view of a given participant.","description":"","operationId":"postConversationsCallParticipantMonitor","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.monitor.own.conversation":"A user cannot monitor a conversation where they are an active participant.","conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:monitor"]},"x-purecloud-method-name":"postConversationsCallParticipantMonitor"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsCallParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallParticipantWrapupcodes"}},"/api/v2/conversations/callbacks":{"get":{"tags":["Conversations"],"summary":"Get active callback conversations for the logged in user","description":"","operationId":"getConversationsCallbacks","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallbackConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallbacks"},"post":{"tags":["Conversations"],"summary":"Create a Callback","description":"","operationId":"postConversationsCallbacks","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Callback","required":true,"schema":{"$ref":"#/definitions/CreateCallbackCommand"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateCallbackResponse"}},"202":{"description":"Accepted - Creating and Processing a Callback"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.missing.callback.numbers":"Callback numbers missing","callback.error.missing.queue.id":"Callback missing queue ID","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","callback.error.scheduled.time.too.far.in.future":"Callback is scheduled to far in the future.","constraint.validation":"%s","callback.error.scheduled.callback.limit.exceeded":"Number of callbacks has been exceeded for a single conversation","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","callback.error.scheduled.callback.number.limit.exceeded":"Number of attributes has exceeded the limit","callback.error.cannot.create.agent.owned.callback":"Cannot create agent owned callback on queue that does not have agent owned callbacks enabled.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:callback:create"]},"x-purecloud-method-name":"postConversationsCallbacks"},"patch":{"tags":["Conversations"],"summary":"Update a scheduled callback","description":"","operationId":"patchConversationsCallbacks","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"PatchCallbackRequest","required":true,"schema":{"$ref":"#/definitions/PatchCallbackRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PatchCallbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","callback.error.missing.required.information.for.patch.request":"The patch request requires either a scheduled time or queueId.","callback.error.scheduled.time.too.far.in.future":"Callback is scheduled to far in the future.","constraint.validation":"%s","callback.error.conversation.not.found":"conversation not found.","callback.error.cannot.update.non.agent.owned.callback":"Cannot update non agent owned callback","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","callback.error.queue.not.found":"queue not found","callback.error.agent.not.member.of.queue":"Agent is not a member of the queue","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","callback.error.scheduled.callback.job.id.not.found":"The scheduled callback job id was not found","callback.error.callback.not.found":"The callback was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"412":{"description":"Precondition Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.already.triggered":"Unable to update an already triggered callback."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","callback.error.unable.to.update.schedule.callback":"Unable to update scheduled callback"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:callback:edit"]},"x-purecloud-method-name":"patchConversationsCallbacks"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsCallbackParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.parse.call.number":"A callback number cannot be parsed as a phone address.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","callback.error.transfer.not.connected":"Only connected participants can be transferred","callback.error.additional.info.value.length.invalid":"The length of the additional info value is invalid.","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","conversations.error.transfer.acd.call.unattended.":"An ACD call cannot be transferred unattended.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.unable.to.schedule.callback":"Server error unable to schedule callback.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationsCallbackParticipantReplace"}},"/api/v2/conversations/callbacks/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get callback conversation","description":"","operationId":"getConversationsCallback","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallbackConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallback"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsCallback","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.empty.conversation.list":"An empty list of conversations is invalid.","conversation.error.cannot.conference.self":"A conversation cannot be merged with itself.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsCallback"}},"/api/v2/conversations/callbacks/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsCallbackRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsCallbackRecordingstate"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsCallbackParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ParticipantAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallbackParticipantAttributes"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsCallbackParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"The participant has no active conversation."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallbackParticipantWrapup"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsCallbackParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallbackParticipantCommunication"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsCallbackParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallbackParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsCallbackParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.communication.not.found":"Communication could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsCallbackParticipantCommunicationWrapup"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsCallbackParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","callback.error.transfer.canceled":"Answer failed because a pending attended transfer was canceled.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"The participant has no active conversation.","callback.error.conversation.not.found":"Conversation not found.","conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","callback.error.answer.not.alerting":"Only alerting calls can be answered.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsCallbackParticipant"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsCallbackParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallbackParticipantWrapupcodes"}},"/api/v2/conversations/chats/{conversationId}/messages/{messageId}":{"get":{"tags":["Conversations"],"summary":"Get a web chat conversation message","description":"The current user must be involved with the conversation to get its messages.","operationId":"getConversationsChatMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"Chat conversation message is not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatMessage"}},"/api/v2/conversations/chats/{conversationId}/messages":{"get":{"tags":["Conversations"],"summary":"Get the messages of a chat conversation.","description":"The current user must be involved with the conversation to get its messages.","operationId":"getConversationsChatMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"after","in":"query","description":"If specified, get the messages chronologically after the id of this message","required":false,"type":"string"},{"name":"before","in":"query","description":"If specified, get the messages chronologically before the id of this message","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"maxResults","in":"query","description":"Limit the returned number of messages, up to a maximum of 100","required":false,"type":"integer","default":100,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessageEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"Chat conversation message is not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatMessages"}},"/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages":{"post":{"tags":["Conversations"],"summary":"Send a message on behalf of a communication in a chat conversation.","description":"","operationId":"postConversationsChatCommunicationMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Message","required":true,"schema":{"$ref":"#/definitions/CreateWebChatMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationmessagerequest.body":"chat error occurred due to null request body.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","chat.error.member.state":"The conversation member is in a state which does not permit this action.","chat.error.bad.request":"Chat error occurred due to bad request.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"Chat conversation message is not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"postConversationsChatCommunicationMessages"}},"/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing":{"post":{"tags":["Conversations"],"summary":"Send a typing-indicator on behalf of a communication in a chat conversation.","description":"","operationId":"postConversationsChatCommunicationTyping","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatTyping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","chat.error.member.state":"The conversation member is in a state which does not permit this action.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"chat conversation typing-indicator is not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"postConversationsChatCommunicationTyping"}},"/api/v2/conversations/chats":{"get":{"tags":["Conversations"],"summary":"Get active chat conversations for the logged in user","description":"","operationId":"getConversationsChats","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChats"},"post":{"tags":["Conversations"],"summary":"Create a web chat conversation","description":"","operationId":"postConversationsChats","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create web chat request","required":true,"schema":{"$ref":"#/definitions/CreateWebChatRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationrequest.provider":"The provider property may not be null.","chat.error.queue.not.found":"The queue does not exist.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","chat.error.notnull.createconversationrequest.queueid":"The queueId property may not be null.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:webchat:create"]},"x-purecloud-method-name":"postConversationsChats"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsChatParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationsChatParticipantReplace"}},"/api/v2/conversations/chats/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get chat conversation","description":"","operationId":"getConversationsChat","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChat"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsChat","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsChat"}},"/api/v2/conversations/chats/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsChatRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsChatRecordingstate"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsChatParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ParticipantAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsChatParticipantAttributes"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsChatParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatParticipantWrapup"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsChatParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Update request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.wrapup.code.required":"Wrapup code is a required field and cannot be empty.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.wrapup.cannot.skip":"Wrap-up cannot be skipped for this participant.","conversation.error.participant.no.active.conversations":"The participant has no active conversation."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsChatParticipant"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsChatParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsChatParticipantCommunication"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsChatParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsChatParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsChatParticipantCommunicationWrapup"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsChatParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatParticipantWrapupcodes"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"postConversationsCobrowsesessionParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationsCobrowsesessionParticipantReplace"}},"/api/v2/conversations/cobrowsesessions":{"get":{"tags":["Conversations"],"summary":"Get active cobrowse conversations for the logged in user","description":"","operationId":"getConversationsCobrowsesessions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CobrowseConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCobrowsesessions"}},"/api/v2/conversations/cobrowsesessions/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get cobrowse conversation","description":"","operationId":"getConversationsCobrowsesession","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CobrowseConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCobrowsesession"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"patchConversationsCobrowsesession","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsCobrowsesession"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsCobrowsesessionRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsCobrowsesessionRecordingstate"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"patchConversationsCobrowsesessionParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ParticipantAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-purecloud-method-name":"patchConversationsCobrowsesessionParticipantAttributes"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"getConversationsCobrowsesessionParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConversationsCobrowsesessionParticipantWrapup"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"patchConversationsCobrowsesessionParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-purecloud-method-name":"patchConversationsCobrowsesessionParticipantCommunication"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"getConversationsCobrowsesessionParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConversationsCobrowsesessionParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"postConversationsCobrowsesessionParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsCobrowsesessionParticipantCommunicationWrapup"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"patchConversationsCobrowsesessionParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsCobrowsesessionParticipant"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"getConversationsCobrowsesessionParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConversationsCobrowsesessionParticipantWrapupcodes"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsEmailParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.error.transfer.replace.external":"External participants may not be replaced.","constraint.validation":"%s","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","postino.error.transfer.not.connected":"Only connected participants can be transferred."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationsEmailParticipantReplace"}},"/api/v2/conversations/emails/{conversationId}/messages/{messageId}":{"get":{"tags":["Conversations"],"summary":"Get conversation message","description":"","operationId":"getConversationsEmailMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","postino.error.org.missing":"OrganizationId header is required.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.get.message.body":"An error occurred retrieving a message body.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The service timeout out waiting on a response.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailMessage"}},"/api/v2/conversations/emails":{"get":{"tags":["Conversations"],"summary":"Get active email conversations for the logged in user","description":"","operationId":"getConversationsEmails","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmails"},"post":{"tags":["Conversations"],"summary":"Create an email conversation","description":"If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.","operationId":"postConversationsEmails","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create email request","required":true,"schema":{"$ref":"#/definitions/CreateEmailRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","email.error.invalid.queue":"An invalid queue ID was specified.","email.outbound.invalid.external.contact":"The external contact supplied is not valid.","invalid.property":"Value [%s] is not a valid property for object [%s]","email.outbound.queue.address.required":"The queue does not have an outbound email address configured.","constraint.validation":"%s","postino.error.notnull.createconversationrequest.queueid":"The queueId property may not be null.","too.many.create.email.parameters":"One of queueId or flowId must be supplied.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","postino.error.notnull.createconversationrequest.provider":"The provider property may not be null.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bad.flow.id":"Invalid flow ID was specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.outbound.queue.required":"An outbound email conversation requires a queue ID."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:email:create"]},"x-purecloud-method-name":"postConversationsEmails"}},"/api/v2/conversations/emails/{conversationId}/messages/draft/attachments/copy":{"post":{"tags":["Conversations"],"summary":"Copy attachments from an email message to the current draft.","description":"","operationId":"postConversationsEmailMessagesDraftAttachmentsCopy","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Copy Attachment Request","required":true,"schema":{"$ref":"#/definitions/CopyAttachmentsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.external.provider":"Operation not supported on emails with external providers.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","postino.error.reply.no.userid":"Reply emails must have a userId.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","postino.error.wrong.org":"Request organization is incorrect for this conversation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsEmailMessagesDraftAttachmentsCopy"}},"/api/v2/conversations/emails/{conversationId}/messages":{"get":{"tags":["Conversations"],"summary":"Get conversation messages","description":"","operationId":"getConversationsEmailMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessagePreviewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The service timeout out waiting on a response.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailMessages"},"post":{"tags":["Conversations"],"summary":"Send an email reply","description":"","operationId":"postConversationsEmailMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Reply","required":true,"schema":{"$ref":"#/definitions/EmailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessageReply"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.attachments.upload.size":"Upload too large.","email.error.external.provider":"Operation not supported on emails with external providers.","email.error.domain.not.verified":"The email domain has not been verified.","bad.request":"The request could not be understood by the server due to malformed syntax.","postino.error.reply.no.body":"Replies must have a textBody or htmlBody.","postino.error.reply.no.sender":"No connected internal participant found for the reply.","postino.error.reply.no.to":"Replies must have a to address.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.reply.no.receiver":"No connected external participant found for the reply.","postino.error.reply.no.userid":"Reply emails must have a userId.","email.error.invalid.email":"Attempted to send an email with an invalid parameter.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.reply.sending":"Error sending an email reply."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The request has timed out.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsEmailMessages"}},"/api/v2/conversations/emails/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get email conversation","description":"","operationId":"getConversationsEmail","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","postino.error.wrong.org":"Request organization is incorrect for this conversation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmail"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsEmail","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsEmail"}},"/api/v2/conversations/emails/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsEmailRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsEmailRecordingstate"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsEmailParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ParticipantAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsEmailParticipantAttributes"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsEmailParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailParticipantWrapup"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsEmailParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Update request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","postino.error.answer.not.alerting":"Only alerting calls can be answered.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"The participant has no active conversation.","conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.transfer.canceled":"Answer failed because a pending attended transfer was canceled.","postino.error.wrong.org":"Request organization is incorrect for this conversation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsEmailParticipant"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsEmailParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsEmailParticipantCommunication"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsEmailParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsEmailParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsEmailParticipantCommunicationWrapup"}},"/api/v2/conversations/emails/{conversationId}/settings":{"get":{"tags":["Conversations"],"summary":"Get emails settings for a given conversation","description":"","operationId":"getConversationsEmailSettings","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailsSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","postino.error.org.missing":"OrganizationId header is required","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","postino.error.wrong.org":"The provided conversationId doesn't belong to the current organization","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.not.found":"The domain that should be used for sending, which is therefore used to determinate the emails settings, cannot be found","postino.error.not.found":"Either the conversation or related elements that permit to retrieve the concerned domain cannot be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailSettings"}},"/api/v2/conversations/emails/{conversationId}/reconnect":{"post":{"tags":["Conversations"],"summary":"Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation","description":"","operationId":"postConversationsEmailReconnect","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.reconnect.already.connected":"Cannot reconnect. Not all communications are disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","email.reconnect.expired":"Cannot reconnect. Conversation is expired based on this organization's email threading settings.","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","email.reconnect.no.internal":"Cannot reconnect. No previous Agent communication found on the conversation.","email.reconnect.no.external":"Cannot reconnect. No previous customer communication found on the conversation.","postino.route.not.found":"Cannot reconnect. No inbound route found.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:reconnect"]},"x-purecloud-method-name":"postConversationsEmailReconnect"}},"/api/v2/conversations/emails/{conversationId}/messages/draft/attachments/{attachmentId}":{"delete":{"tags":["Conversations"],"summary":"Delete attachment from draft","description":"","operationId":"deleteConversationsEmailMessagesDraftAttachment","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"attachmentId","in":"path","description":"attachmentId","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","postino.error.org.missing":"OrganizationId header is required."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationsEmailMessagesDraftAttachment"}},"/api/v2/conversations/emails/{conversationId}/messages/draft":{"get":{"tags":["Conversations"],"summary":"Get conversation draft reply","description":"","operationId":"getConversationsEmailMessagesDraft","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","postino.error.org.missing":"OrganizationId header is required.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.get.message.body":"An error occurred retrieving a message body.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailMessagesDraft"},"put":{"tags":["Conversations"],"summary":"Update conversation draft reply","description":"","operationId":"putConversationsEmailMessagesDraft","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Draft","required":true,"schema":{"$ref":"#/definitions/EmailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.external.provider":"Operation not supported on emails with external providers.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"putConversationsEmailMessagesDraft"},"patch":{"tags":["Conversations"],"summary":"Reset conversation draft to its initial state and/or auto-fill draft content","description":"","operationId":"patchConversationsEmailMessagesDraft","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"autoFill","in":"query","description":"autoFill","required":false,"type":"boolean"},{"name":"discard","in":"query","description":"discard","required":false,"type":"boolean"},{"in":"body","name":"body","description":"Draft Manipulation Request","required":false,"schema":{"$ref":"#/definitions/DraftManipulationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax or missing field(s).","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.route.not.found":"The inbound route does not exist.","constraint.validation":"%s","postino.error.wrong.org":"OrganizationId does not match the resources organization.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization.","postino.error.forbidden":"User is not an active participant on the conversation","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.draft.initialized":"The draft is already initialized."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsEmailMessagesDraft"}},"/api/v2/conversations/emails/{conversationId}/inboundmessages":{"post":{"tags":["Conversations"],"summary":"Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.","description":"","operationId":"postConversationsEmailInboundmessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Send external email reply","required":true,"schema":{"$ref":"#/definitions/InboundMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","email.error.invalid.queue":"An invalid queue ID was specified.","email.error.internal.provider":"Operation not supported on emails with PureCloud providers","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","postino.error.notnull.createconversationrequest.provider":"The provider property may not be null.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bad.flow.id":"Invalid flow ID was specified.","too.many.external.email.parameters":"Only one of queueId or flowId may be provided","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsEmailInboundmessages"}},"/api/v2/conversations/emails/agentless":{"post":{"tags":["Conversations"],"summary":"Create an email conversation, per API","description":"","operationId":"postConversationsEmailsAgentless","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create agentless email request","required":true,"schema":{"$ref":"#/definitions/AgentlessEmailSendRequestDto"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentlessEmailSendResponseDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.error.subject.too.long":"The subject message was too long.","postino.error.invalid.sender.type":"The sender type is invalid","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.not.verified":"The outbound domain is not verified.","postino.error.missing.field":"Missing required field","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.conversation.not.found":"The conversation does not exist or is not an email interaction.","postino.error.not.found":"The outbound domain does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error":"An error has occurred. Please contact support.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","postino.error.internal":"An internal service error has occurred. Please contact support."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:email:create","conversation:agentlessEmail:send"]},"x-purecloud-method-name":"postConversationsEmailsAgentless"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsEmailParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailParticipantWrapupcodes"}},"/api/v2/emails/settings":{"get":{"tags":["Emails","Settings"],"summary":"Get email Contact Center settings","description":"","operationId":"getEmailsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:settings:view"]},"x-purecloud-method-name":"getEmailsSettings"},"patch":{"tags":["Emails","Settings"],"summary":"Patch email Contact Center settings","description":"","operationId":"patchEmailsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/EmailSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:settings:edit"]},"x-purecloud-method-name":"patchEmailsSettings"}},"/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}":{"get":{"tags":["Conversations"],"summary":"Get a cached media item","description":"","operationId":"getConversationsMessagesCachedmediaCachedMediaItemId","produces":["application/json"],"parameters":[{"name":"cachedMediaItemId","in":"path","description":"cachedMediaItemId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CachedMediaItem"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:cachedMedia:view"]},"x-purecloud-method-name":"getConversationsMessagesCachedmediaCachedMediaItemId"},"delete":{"tags":["Conversations"],"summary":"Remove a cached media item asychronously","description":"","operationId":"deleteConversationsMessagesCachedmediaCachedMediaItemId","produces":["application/json"],"parameters":[{"name":"cachedMediaItemId","in":"path","description":"cachedMediaItemId","required":true,"type":"string"}],"responses":{"202":{"description":"Request accepted to delete media from cache"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:cachedMedia:delete"]},"x-purecloud-method-name":"deleteConversationsMessagesCachedmediaCachedMediaItemId"}},"/api/v2/conversations/messages/cachedmedia":{"get":{"tags":["Conversations"],"summary":"Get a list of cached media items","description":"","operationId":"getConversationsMessagesCachedmedia","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"url","in":"query","description":"URL to search for","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CachedMediaItemEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:cachedMedia:view"]},"x-purecloud-method-name":"getConversationsMessagesCachedmedia"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsMessageParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationsMessageParticipantReplace"}},"/api/v2/conversations/messages/{messageId}/details":{"get":{"tags":["Conversations"],"summary":"Get message","description":"","operationId":"getConversationsMessageDetails","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"},{"name":"useNormalizedMessage","in":"query","description":"If true, response removes deprecated fields (textBody, media, stickers)","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:view","conversation:webmessaging:view"]},"x-purecloud-method-name":"getConversationsMessageDetails"}},"/api/v2/conversations/messages":{"get":{"tags":["Conversations"],"summary":"Get active message conversations for the logged in user","description":"","operationId":"getConversationsMessages","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessages"},"post":{"tags":["Conversations"],"summary":"Create an outbound messaging conversation.","description":"If there is an existing conversation between the remote address and the address associated with the queue specified in createOutboundRequest then the result of this request depends on the state of that conversation and the useExistingConversation field of createOutboundRequest. If the existing conversation is in alerting or connected state, then the request will fail. If the existing conversation is disconnected but still within the conversation window then the request will fail unless useExistingConversation is set to true.","operationId":"postConversationsMessages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create outbound messaging conversation","required":true,"schema":{"$ref":"#/definitions/CreateOutboundMessagingConversationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-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}/messages/bulk":{"post":{"tags":["Conversations"],"summary":"Get messages in batch","description":"The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: [\"a3069a33b-bbb1-4703-9d68-061d9e9db96e\", \"55bc6be3-078c-4a49-a4e6-1e05776ed7e8\"]","operationId":"postConversationsMessageMessagesBulk","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","required":true,"type":"string"},{"name":"useNormalizedMessage","in":"query","description":"If true, response removes deprecated fields (textBody, media, stickers)","required":false,"type":"boolean","default":false},{"in":"body","name":"body","description":"messageIds","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TextMessageListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:view","conversation:webmessaging:view"]},"x-purecloud-method-name":"postConversationsMessageMessagesBulk"}},"/api/v2/conversations/messages/{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":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"organization.outbound.usage.limit.exceeded":"Max outbound message usage exceeded."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:create","conversation:webmessaging:create"]},"x-purecloud-method-name":"postConversationsMessageCommunicationMessages"}},"/api/v2/conversations/messages/inbound/open":{"post":{"tags":["Conversations"],"summary":"Send an inbound Open Message","description":"[This API is deprecated. Instead, use 1. POST /api/v2/conversations/messages/{integrationId}/inbound/open/event, if you want to send an inbound Open Event Message 2. POST /api/v2/conversations/messages/{integrationId}/inbound/open/message, if you want to send an inbound Open Message 3. POST /api/v2/conversations/messages/{integrationId}/inbound/open/receipt, to send an inbound Open Receipt Message] In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.","operationId":"postConversationsMessagesInboundOpen","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"NormalizedMessage","required":true,"schema":{"$ref":"#/definitions/OpenNormalizedMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenNormalizedMessage"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/OpenNormalizedMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.open.channel.date":"Missing open channel date.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:receive"]},"x-purecloud-method-name":"postConversationsMessagesInboundOpen"}},"/api/v2/conversations/messages/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get message conversation","description":"","operationId":"getConversationsMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessage"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsMessage"}},"/api/v2/conversations/messages/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsMessageRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsMessageRecordingstate"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsMessageParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ParticipantAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsMessageParticipantAttributes"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsMessageParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessageParticipantWrapup"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsMessageParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"Participant has no active conversations"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsMessageParticipant"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsMessageParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsMessageParticipantCommunication"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsMessageParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessageParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsMessageParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsMessageParticipantCommunicationWrapup"}},"/api/v2/conversations/messages/{conversationId}/messages/{messageId}":{"get":{"tags":["Conversations"],"summary":"Get conversation message","description":"","operationId":"getConversationsMessageMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"},{"name":"useNormalizedMessage","in":"query","description":"If true, response removes deprecated fields (textBody, media, stickers)","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:view","conversation:webmessaging:view"]},"x-purecloud-method-name":"getConversationsMessageMessage"}},"/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media":{"post":{"tags":["Conversations"],"summary":"Create media","description":"See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.","operationId":"postConversationsMessageCommunicationMessagesMedia","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/MessageMediaData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:create","conversation:webmessaging:create","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:view","conversation:webmessaging:view"]},"x-purecloud-method-name":"getConversationsMessageCommunicationMessagesMediaMediaId"}},"/api/v2/conversations/messages/agentless":{"post":{"tags":["Conversations"],"summary":"Send an agentless outbound message","description":"Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the 'fromAddress' and 'toAddress' specified, the 'useExistingActiveConversation' param can be used to barge in to the ongoing conversation.","operationId":"postConversationsMessagesAgentless","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create agentless outbound messaging request","required":true,"schema":{"$ref":"#/definitions/SendAgentlessOutboundMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SendAgentlessOutboundMessageResponse"}},"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","bad.request":"The request could not be understood by the server due to malformed syntax.","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.whatsapp.address":"WhatsApp address must only contain numeric characters of destination phone number.","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","active.conversation":"An alerting or connected conversation is already in progress.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","existing.conversation":"An existing conversation within the conversation window is in progress."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"organization.outbound.usage.limit.exceeded":"Max outbound message usage exceeded."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:create"]},"x-purecloud-method-name":"postConversationsMessagesAgentless"}},"/api/v2/conversations/messages/{integrationId}/inbound/open/event":{"post":{"tags":["Conversations"],"summary":"Send an inbound Open Event Message","description":"Send an inbound event message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.","operationId":"postConversationsMessageInboundOpenEvent","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"integrationId","required":true,"type":"string"},{"in":"body","name":"body","description":"NormalizedMessage","required":true,"schema":{"$ref":"#/definitions/OpenInboundNormalizedEvent"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenEventNormalizedMessage"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/OpenEventNormalizedMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.open.channel.date":"Missing open channel date.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:receive"]},"x-purecloud-method-name":"postConversationsMessageInboundOpenEvent"}},"/api/v2/conversations/messages/{integrationId}/inbound/open/message":{"post":{"tags":["Conversations"],"summary":"Send inbound Open Message","description":"Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.","operationId":"postConversationsMessageInboundOpenMessage","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"integrationId","required":true,"type":"string"},{"in":"body","name":"body","description":"NormalizedMessage","required":true,"schema":{"$ref":"#/definitions/OpenInboundNormalizedMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenMessageNormalizedMessage"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/OpenMessageNormalizedMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.open.channel.date":"Missing open channel date.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:receive"]},"x-purecloud-method-name":"postConversationsMessageInboundOpenMessage"}},"/api/v2/conversations/messages/{integrationId}/inbound/open/receipt":{"post":{"tags":["Conversations"],"summary":"Send an inbound Open Receipt Message","description":"Send an inbound open Receipt to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.","operationId":"postConversationsMessageInboundOpenReceipt","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"integrationId","required":true,"type":"string"},{"in":"body","name":"body","description":"NormalizedMessage","required":true,"schema":{"$ref":"#/definitions/OpenInboundNormalizedReceipt"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenReceiptNormalizedMessage"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/OpenReceiptNormalizedMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.open.channel.date":"Missing open channel date.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:receive"]},"x-purecloud-method-name":"postConversationsMessageInboundOpenReceipt"}},"/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing":{"post":{"tags":["Conversations"],"summary":"Send message typing event","description":"Send message typing event for existing conversation/communication.","operationId":"postConversationsMessageCommunicationTyping","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"MessageTypingEvent","required":true,"schema":{"$ref":"#/definitions/MessageTypingEventRequest"}}],"responses":{"204":{"description":"Message typing event sent"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:create","conversation:webmessaging:create"]},"x-purecloud-method-name":"postConversationsMessageCommunicationTyping"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/monitor":{"post":{"tags":["Conversations"],"summary":"Listen in on the conversation from the point of view of a given participant.","description":"","operationId":"postConversationsMessageParticipantMonitor","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.monitor.own.conversation":"A user cannot monitor a conversation where they are an active participant.","too.many.monitors":"Only one monitor is allowed per conversation.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:monitor"]},"x-purecloud-method-name":"postConversationsMessageParticipantMonitor"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsMessageParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessageParticipantWrapupcodes"}},"/api/v2/conversations/screenshares/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"putConversationsScreenshareRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsScreenshareRecordingstate"}},"/api/v2/conversations/screenshares/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"getConversationsScreenshareParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConversationsScreenshareParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"postConversationsScreenshareParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsScreenshareParticipantCommunicationWrapup"}},"/api/v2/conversations/socials/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsSocialRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsSocialRecordingstate"}},"/api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsSocialParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsSocialParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsSocialParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsSocialParticipantCommunicationWrapup"}},"/api/v2/conversations/videos/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsVideoRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsVideoRecordingstate"}},"/api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsVideoParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsVideoParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsVideoParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsVideoParticipantCommunicationWrapup"}},"/api/v2/conversations/messaging/integrations":{"get":{"tags":["Conversations"],"summary":"Get a list of Integrations","description":"","operationId":"getConversationsMessagingIntegrations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"array","items":{"type":"string","enum":["supportedContent","messagingSetting"]},"collectionFormat":"multi"},{"name":"supportedContent.id","in":"query","description":"Filter integrations returned based on the supported content ID","required":false,"type":"string"},{"name":"messagingSetting.id","in":"query","description":"Filter integrations returned based on the setting ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrations"}},"/api/v2/conversations/messaging/threadingtimeline":{"get":{"tags":["Conversations"],"summary":"Get conversation threading window timeline for each messaging type","description":"Conversation messaging threading timeline is a setting defined for each messenger type in your organization. This setting will dictate whether a new message is added to the most recent existing conversation, or creates a new Conversation. If the existing Conversation is still in a connected state the threading timeline setting will never play a role. After the conversation is disconnected, if an inbound message is received or an outbound message is sent after the setting for threading timeline expires, a new conversation is created.","operationId":"getConversationsMessagingThreadingtimeline","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationThreadingWindow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:threadingTimeline:view"]},"x-purecloud-method-name":"getConversationsMessagingThreadingtimeline"},"put":{"tags":["Conversations"],"summary":"Update conversation threading window timeline for each messaging type","description":"PUT Conversation messaging threading timeline is intended to set the conversation threading settings for ALL messengerTypes. If you omit a messengerType in the request body then the setting for that messengerType will use the platform default value. The PUT replaces the existing setting(s) that were previously set for each messengerType.","operationId":"putConversationsMessagingThreadingtimeline","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ConversationThreadingWindowRequest","required":true,"schema":{"$ref":"#/definitions/ConversationThreadingWindow"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationThreadingWindow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.threading.window.timeout":"The provided conversation threading window timeout for a messaging type is invalid","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:threadingTimeline:edit"]},"x-purecloud-method-name":"putConversationsMessagingThreadingtimeline"}},"/api/v2/conversations/messaging/facebook/app":{"get":{"tags":["Conversations"],"summary":"Get Genesys Facebook App Id","description":"","operationId":"getConversationsMessagingFacebookApp","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookAppCredentials"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:add"]},"x-purecloud-method-name":"getConversationsMessagingFacebookApp"}},"/api/v2/conversations/messaging/integrations/facebook/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get a Facebook messaging integration","description":"","operationId":"getConversationsMessagingIntegrationsFacebookIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsFacebookIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete a Facebook messaging integration","description":"","operationId":"deleteConversationsMessagingIntegrationsFacebookIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recipient.has.flow":"Facebook integration cannot be deleted with an existing flow associated to it. Remove associated flow before deleting integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsFacebookIntegrationId"},"patch":{"tags":["Conversations"],"summary":"Update Facebook messaging integration","description":"","operationId":"patchConversationsMessagingIntegrationsFacebookIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"FacebookIntegrationUpdateRequest","required":true,"schema":{"$ref":"#/definitions/FacebookIntegrationUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsFacebookIntegrationId"}},"/api/v2/conversations/messaging/integrations/facebook":{"get":{"tags":["Conversations"],"summary":"Get a list of Facebook Integrations","description":"","operationId":"getConversationsMessagingIntegrationsFacebook","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]},{"name":"supportedContent.id","in":"query","description":"Filter integrations returned based on the supported content ID","required":false,"type":"string"},{"name":"messagingSetting.id","in":"query","description":"Filter integrations returned based on the setting ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsFacebook"},"post":{"tags":["Conversations"],"summary":"Create a Facebook Integration","description":"","operationId":"postConversationsMessagingIntegrationsFacebook","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"FacebookIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/FacebookIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegration"}},"202":{"description":"Accepted - The integration creation in progress.","schema":{"$ref":"#/definitions/FacebookIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"The provided access token is missing Facebook permissions for this feature.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.access.token.combination":"The request requires either the pageId and userAccessToken fields, or the pageAccessToken field.","missing.required.field.value":"A required field was not provided or is blank.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","unsupported.message.channel":"Unsupported messageChannel.","constraint.validation":"%s","facebook.public.not.yet.supported":"Facebook Public not yet supported.","could.not.find.page.access.token":"Could not find Page Access Token for the pageId provided.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.page.access.token.provided":"Provided Page Access Token is invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.already.integrated":"There is an existing integration for this page with the requested feature.","existing.active.webhook.facebook.subscription":"There is another active webhook subscription for this Facebook App."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsFacebook"}},"/api/v2/conversations/messaging/facebook/permissions":{"get":{"tags":["Conversations"],"summary":"Get a list of Facebook Permissions","description":"","operationId":"getConversationsMessagingFacebookPermissions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Completed request for public message.","schema":{"$ref":"#/definitions/FacebookPermissionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["messaging:integration:add","messaging:integration:edit","messaging:conversationInstagramIntegration:add"]},"x-purecloud-method-name":"getConversationsMessagingFacebookPermissions"}},"/api/v2/conversations/messaging/integrations/instagram/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get Instagram messaging integration","description":"","operationId":"getConversationsMessagingIntegrationsInstagramIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InstagramIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsInstagramIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete Instagram messaging integration","description":"","operationId":"deleteConversationsMessagingIntegrationsInstagramIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recipient.has.flow":"Instagram integration cannot be deleted with an existing flow associated to it. Remove associated flow before deleting integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsInstagramIntegrationId"},"patch":{"tags":["Conversations"],"summary":"Update Instagram messaging integration","description":"","operationId":"patchConversationsMessagingIntegrationsInstagramIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"InstagramIntegrationUpdateRequest","required":true,"schema":{"$ref":"#/definitions/InstagramIntegrationUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InstagramIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsInstagramIntegrationId"}},"/api/v2/conversations/messaging/integrations/instagram":{"get":{"tags":["Conversations"],"summary":"Get a list of Instagram Integrations","description":"","operationId":"getConversationsMessagingIntegrationsInstagram","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]},{"name":"supportedContent.id","in":"query","description":"Filter integrations returned based on the supported content ID","required":false,"type":"string"},{"name":"messagingSetting.id","in":"query","description":"Filter integrations returned based on the setting ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InstagramIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsInstagram"},"post":{"tags":["Conversations"],"summary":"Create Instagram Integration","description":"","operationId":"postConversationsMessagingIntegrationsInstagram","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"InstagramIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/InstagramIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InstagramIntegration"}},"202":{"description":"Accepted - If async is true, the integration creation in progress.","schema":{"$ref":"#/definitions/InstagramIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"The provided access token is missing Instagram permissions for this feature.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.access.token.combination":"The request requires either the pageId and userAccessToken fields, or the pageAccessToken field.","missing.required.field.value":"A required field was not provided or is blank.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","could.not.find.page.access.token":"Could not find Page Access Token for the pageId provided.","instagram.not.yet.supported":"Instagram not yet supported.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","no.instagram.account.associated.with.page":"No Instagram account associated with page.","invalid.page.access.token.provided":"Provided Page Access Token is invalid.","page.subscription.error":"Encountered an error while subscribing Facebook page to webhooks. Verify that any existing integration linked to this page is in a valid state","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.already.integrated":"There is an existing integration for this page with the requested feature."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:conversationInstagramIntegration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsInstagram"}},"/api/v2/conversations/messaging/integrations/open/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get an Open messaging integration","description":"See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.","operationId":"getConversationsMessagingIntegrationsOpenIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsOpenIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete an Open messaging integration","description":"See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.","operationId":"deleteConversationsMessagingIntegrationsOpenIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recipient.has.flow":"Open messaging integration cannot be deleted with an existing flow associated to it. Remove associated flow before deleting integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsOpenIntegrationId"},"patch":{"tags":["Conversations"],"summary":"Update an Open messaging integration","description":"See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.","operationId":"patchConversationsMessagingIntegrationsOpenIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"OpenIntegrationUpdateRequest","required":true,"schema":{"$ref":"#/definitions/OpenIntegrationUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.outbound.webhook.url":"The outboundNotificationWebhookUrl provided is not a valid url.","too.many.webhook.headers":"Too many webhook headers provided.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","notification.webhook.signature.secret.token.longer.than.15.characters":"The notification webhook signature secret token for the integration must be longer than 15 characters."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsOpenIntegrationId"}},"/api/v2/conversations/messaging/integrations/open":{"get":{"tags":["Conversations"],"summary":"Get a list of Open messaging integrations","description":"See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.","operationId":"getConversationsMessagingIntegrationsOpen","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]},{"name":"supportedContent.id","in":"query","description":"Filter integrations returned based on the supported content ID","required":false,"type":"string"},{"name":"messagingSetting.id","in":"query","description":"Filter integrations returned based on the setting ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsOpen"},"post":{"tags":["Conversations"],"summary":"Create an Open messaging integration","description":"See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.","operationId":"postConversationsMessagingIntegrationsOpen","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"OpenIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/OpenIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenIntegration"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/OpenIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","missing.required.field.value":"A required field was not provided or is blank.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","notification.webhook.signature.secret.token.longer.than.15.characters":"The notification webhook signature secret token for the integration must be longer than 15 characters.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.outbound.webhook.url":"The outboundNotificationWebhookUrl provided is not a valid url.","too.many.webhook.headers":"Too many webhook headers provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsOpen"}},"/api/v2/conversations/messaging/settings/default":{"get":{"tags":["Conversations"],"summary":"Get the organization's default settings that will be used as the default when creating an integration.","description":"When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.","operationId":"getConversationsMessagingSettingsDefault","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:view"]},"x-purecloud-method-name":"getConversationsMessagingSettingsDefault"},"put":{"tags":["Conversations"],"summary":"Set the organization's default setting that may be applied to to integrations without settings","description":"When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.","operationId":"putConversationsMessagingSettingsDefault","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"MessagingSetting","required":true,"schema":{"$ref":"#/definitions/MessagingSettingDefaultRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:edit"]},"x-purecloud-method-name":"putConversationsMessagingSettingsDefault"},"delete":{"tags":["Conversations"],"summary":"Delete the organization's default setting, a global default will be applied to integrations without settings","description":"When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.","operationId":"deleteConversationsMessagingSettingsDefault","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingSettingsDefault"}},"/api/v2/conversations/messaging/settings":{"get":{"tags":["Conversations"],"summary":"Get a list of messaging settings","description":"","operationId":"getConversationsMessagingSettings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingConfigListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:view"]},"x-purecloud-method-name":"getConversationsMessagingSettings"},"post":{"tags":["Conversations"],"summary":"Create a messaging setting","description":"","operationId":"postConversationsMessagingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"MessagingSetting","required":true,"schema":{"$ref":"#/definitions/MessagingSettingRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"201":{"description":"Operation was successful","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.messaging.setting":"The messaging setting request was invalid. One or more errors may be reported.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:add"]},"x-purecloud-method-name":"postConversationsMessagingSettings"}},"/api/v2/conversations/messaging/settings/{messageSettingId}":{"get":{"tags":["Conversations"],"summary":"Get a messaging setting","description":"","operationId":"getConversationsMessagingSetting","produces":["application/json"],"parameters":[{"name":"messageSettingId","in":"path","description":"Message Setting ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:view"]},"x-purecloud-method-name":"getConversationsMessagingSetting"},"delete":{"tags":["Conversations"],"summary":"Delete a messaging setting","description":"","operationId":"deleteConversationsMessagingSetting","produces":["application/json"],"parameters":[{"name":"messageSettingId","in":"path","description":"Message Setting ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"supported.content.in.use":"The supported content profile is in use by an integration","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingSetting"},"patch":{"tags":["Conversations"],"summary":"Update a messaging setting","description":"","operationId":"patchConversationsMessagingSetting","produces":["application/json"],"parameters":[{"name":"messageSettingId","in":"path","description":"Message Setting ID","required":true,"type":"string"},{"in":"body","name":"body","description":"MessagingSetting","required":true,"schema":{"$ref":"#/definitions/MessagingSettingPatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.messaging.setting":"The messaging setting request was invalid. One or more errors may be reported.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:edit"]},"x-purecloud-method-name":"patchConversationsMessagingSetting"}},"/api/v2/conversations/messaging/supportedcontent/default":{"get":{"tags":["Conversations"],"summary":"Get the organization's default supported content profile that will be used as the default when creating an integration.","description":"When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.","operationId":"getConversationsMessagingSupportedcontentDefault","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:view"]},"x-purecloud-method-name":"getConversationsMessagingSupportedcontentDefault"},"put":{"tags":["Conversations"],"summary":"Set the organization's default supported content profile that may be assigned to an integration when it is created.","description":"When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.","operationId":"putConversationsMessagingSupportedcontentDefault","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SupportedContent","required":true,"schema":{"$ref":"#/definitions/SupportedContentReference"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"supported.content.id.required":"The supported content ID is required","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:edit"]},"x-purecloud-method-name":"putConversationsMessagingSupportedcontentDefault"}},"/api/v2/conversations/messaging/supportedcontent/{supportedContentId}":{"get":{"tags":["Conversations"],"summary":"Get a supported content profile","description":"","operationId":"getConversationsMessagingSupportedcontentSupportedContentId","produces":["application/json"],"parameters":[{"name":"supportedContentId","in":"path","description":"Supported Content ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:view"]},"x-purecloud-method-name":"getConversationsMessagingSupportedcontentSupportedContentId"},"delete":{"tags":["Conversations"],"summary":"Delete a supported content profile","description":"","operationId":"deleteConversationsMessagingSupportedcontentSupportedContentId","produces":["application/json"],"parameters":[{"name":"supportedContentId","in":"path","description":"Supported Content ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"supported.content.in.use":"The supported content profile is in use by an integration","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingSupportedcontentSupportedContentId"},"patch":{"tags":["Conversations"],"summary":"Update a supported content profile","description":"","operationId":"patchConversationsMessagingSupportedcontentSupportedContentId","produces":["application/json"],"parameters":[{"name":"supportedContentId","in":"path","description":"Supported Content ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SupportedContent","required":true,"schema":{"$ref":"#/definitions/SupportedContent"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.media.type":"A media type string as defined by RFC 2046 is invalid. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","maximum.supported.content.media.types.exceeded":"The maximum number of media types defined for the supported content profile has been exceeded","invalid.supported.content":"The supported content request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:edit"]},"x-purecloud-method-name":"patchConversationsMessagingSupportedcontentSupportedContentId"}},"/api/v2/conversations/messaging/supportedcontent":{"get":{"tags":["Conversations"],"summary":"Get a list of Supported Content profiles","description":"","operationId":"getConversationsMessagingSupportedcontent","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:view"]},"x-purecloud-method-name":"getConversationsMessagingSupportedcontent"},"post":{"tags":["Conversations"],"summary":"Create a Supported Content profile","description":"","operationId":"postConversationsMessagingSupportedcontent","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SupportedContent","required":true,"schema":{"$ref":"#/definitions/SupportedContent"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"201":{"description":"Operation was successful","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.media.type":"A media type string as defined by RFC 2046. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types.","maximum.supported.content.profiles.exceeded":"The maximum number of supported content profiles created for an organization has been exceeded","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","maximum.supported.content.media.types.exceeded":"The maximum number of media types defined for the supported content profile has been exceeded","invalid.supported.content":"The supported content request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["messaging:supportedContent:add"]},"x-purecloud-method-name":"postConversationsMessagingSupportedcontent"}},"/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup/{integrationId}":{"patch":{"tags":["Conversations"],"summary":"Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow","description":"Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the POST call to create the integration. You can then run a GET on the integration to check if its status has been updated to Active","operationId":"patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"WhatsAppEmbeddedSignupIntegrationActivationRequest","required":true,"schema":{"$ref":"#/definitions/WhatsAppEmbeddedSignupIntegrationActivationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Accepted - The integration activation in progress.","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.phone.number":"The phone number provided is invalid as it is not in E.164 phone format.","phone.number.not.found.on.waba":"The phone number provided was not found on the WABA.","invalid.property":"Value [%s] is not a valid property for object [%s]","missing.required.field.value":"A required field was not provided or is blank.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"please.ensure.two.factor.authentication.is.disabled":"Please ensure two-factor authentication is disabled.","phone.number.already.in.use":"A WhatsApp integration has already been created for this phone number."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId"}},"/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup":{"post":{"tags":["Conversations"],"summary":"Create a WhatsApp Integration using the WhatsApp embedded signup flow","description":"Use the access token returned from the embedded signup flow to obtain a list of available phone numbers that can be associated with the created integration. The returned WhatsApp integration will initially have a createStatus of Initiated until the list of available phone numbers can be obtained from the provider. Please run a GET on the created integration until it returns a createStatus of Completed, and the list of available phone numbers obtained from the provider. You can then specify one of the available phone numbers in the PATCH call on the integration to activate it.","operationId":"postConversationsMessagingIntegrationsWhatsappEmbeddedsignup","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"WhatsAppEmbeddedSignupIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/WhatsAppEmbeddedSignupIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Accepted - The integration creation in progress.","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","missing.required.field.value":"A required field was not provided or is blank.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.integrations.for.this.message.channel":"There are too many WhatsApp integrations already created.","phone.number.already.in.use":"A WhatsApp integration has already been created for this phone number."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:whatsappIntegration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsWhatsappEmbeddedsignup"}},"/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get a WhatsApp messaging integration","description":"","operationId":"getConversationsMessagingIntegrationsWhatsappIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsWhatsappIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete a WhatsApp messaging integration","description":"","operationId":"deleteConversationsMessagingIntegrationsWhatsappIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Request Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recipient.has.flow":"WhatsApp integration cannot be deleted with an existing flow associated to it. Remove associated flow before deleting integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsWhatsappIntegrationId"},"patch":{"tags":["Conversations"],"summary":"Update a WhatsApp messaging integration","description":"","operationId":"patchConversationsMessagingIntegrationsWhatsappIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"WhatsAppIntegrationUpdateRequest","required":true,"schema":{"$ref":"#/definitions/WhatsAppIntegrationUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Processing Request","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsWhatsappIntegrationId"}},"/api/v2/conversations/messaging/integrations/whatsapp":{"get":{"tags":["Conversations"],"summary":"Get a list of WhatsApp Integrations","description":"","operationId":"getConversationsMessagingIntegrationsWhatsapp","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]},{"name":"supportedContent.id","in":"query","description":"Filter integrations returned based on the supported content ID","required":false,"type":"string"},{"name":"messagingSetting.id","in":"query","description":"Filter integrations returned based on the setting ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsWhatsapp"},"post":{"tags":["Conversations"],"summary":"[This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration","description":"[This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.","operationId":"postConversationsMessagingIntegrationsWhatsapp","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"WhatsAppIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/WhatsAppIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Accepted - The integration creation in progress.","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.phone.number":"The phone number provided is invalid as it is not in E.164 phone format.","invalid.property":"Value [%s] is not a valid property for object [%s]","missing.required.field.value":"A required field was not provided or is blank.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.integrations.for.this.message.channel":"There are too many WhatsApp integrations already created.","phone.number.already.in.use":"A WhatsApp integration has already been created for this phone number."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:whatsappIntegration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsWhatsapp"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode}":{"delete":{"tags":["Conversations"],"summary":"Delete a code used to add a communication to this participant","description":"","operationId":"deleteConversationParticipantCode","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"addCommunicationCode","in":"path","description":"addCommunicationCode","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationParticipantCode"}},"/api/v2/conversations/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update a participant.","description":"Update conversation participant.","operationId":"patchConversationParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Update request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversation.error.cannot.disconnect.call":"The call for this request cannot be disconnected.","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversation.error.hold.alerting":"An alerting call cannot be placed on hold","conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.cannot.confine.party":"The participant for this request cannot be confined.","conversation.error.wrapup.code.required":"Wrapup code is a required field and cannot be empty.","conversation.error.participant.attribute.null":"Cannot update participant attribute map to a null value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationParticipant"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.chat.external":"Participants with chats cannot be transferred to external addresses.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","conversations.error.transfer.destination.required":"The destination is a required property for a transfer request.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversations.error.transfer.userCall.voicemail":"Only personal calls can be transferred to voicemail.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","conversations.error.transfer.chat.voicemail":"Participants with chats cannot be transferred to voicemail.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationParticipantReplace"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/digits":{"post":{"tags":["Conversations"],"summary":"Sends DTMF to the participant","description":"","operationId":"postConversationParticipantDigits","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Digits","required":false,"schema":{"$ref":"#/definitions/Digits"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationParticipantDigits"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/callbacks":{"post":{"tags":["Conversations"],"summary":"Create a new callback for the specified participant on the conversation.","description":"","operationId":"postConversationParticipantCallbacks","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateCallbackOnConversationCommand"}}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.callback.already.being.routed":"A callback is already in the process of being routed on this conversation.","callback.error.parse.call.number":"A callback number cannot be parsed as a phone address.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversation.error.queue.required":"Queue id is required for this request.","callback.error.scheduled.time.too.far.in.future":"The callback scheduled time cannot be more than 30 days into the future.","constraint.validation":"%s","conversation.error.cannot.callback.acd":"Cannot create a callback for an ACD participant.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","callback.error.scheduled.callback.already.exists":"A callback is already scheduled on this conversation.","callback.error.target.communication.cannot.be.acd.or.ivr":"Target communication cannot belong to an acd or ivr participant.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:callback:create"]},"x-purecloud-method-name":"postConversationParticipantCallbacks"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"The participant does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationParticipantAttributes"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantWrapup"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/replace/agent":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified agent","description":"","operationId":"postConversationParticipantReplaceAgent","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferToAgentRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.chat.external":"Participants with chats cannot be transferred to external addresses.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","conversations.error.transfer.destination.required":"The destination is a required property for a transfer request.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversations.error.transfer.userCall.voicemail":"Only personal calls can be transferred to voicemail.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","conversations.error.transfer.chat.voicemail":"Participants with chats cannot be transferred to voicemail.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer","conversation:communication:blindTransferAgent"]},"x-purecloud-method-name":"postConversationParticipantReplaceAgent"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/replace/queue":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified queue","description":"","operationId":"postConversationParticipantReplaceQueue","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferToQueueRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.chat.external":"Participants with chats cannot be transferred to external addresses.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","conversations.error.transfer.destination.required":"The destination is a required property for a transfer request.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversations.error.transfer.userCall.voicemail":"Only personal calls can be transferred to voicemail.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","conversations.error.transfer.chat.voicemail":"Participants with chats cannot be transferred to voicemail.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer","conversation:communication:blindTransferQueue"]},"x-purecloud-method-name":"postConversationParticipantReplaceQueue"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/replace/external":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the an external contact","description":"","operationId":"postConversationParticipantReplaceExternal","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferToExternalRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.chat.external":"Participants with chats cannot be transferred to external addresses.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","conversations.error.transfer.destination.required":"The destination is a required property for a transfer request.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversations.error.transfer.userCall.voicemail":"Only personal calls can be transferred to voicemail.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","conversations.error.transfer.chat.voicemail":"Participants with chats cannot be transferred to voicemail.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer","conversation:communication:blindTransferExternal"]},"x-purecloud-method-name":"postConversationParticipantReplaceExternal"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason":{"put":{"tags":["Conversations"],"summary":"Set flagged reason on conversation participant to indicate bad conversation quality.","description":"","operationId":"putConversationParticipantFlaggedreason","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"204":{"description":"The flagged reason was set successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"putConversationParticipantFlaggedreason"},"delete":{"tags":["Conversations"],"summary":"Remove flagged reason from conversation participant.","description":"","operationId":"deleteConversationParticipantFlaggedreason","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"204":{"description":"The flagged reason was removed successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationParticipantFlaggedreason"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantWrapupcodes"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId}":{"get":{"tags":["Conversations"],"summary":"Fetch info on a secure session","description":"","operationId":"getConversationParticipantSecureivrsession","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"secureSessionId","in":"path","description":"secure IVR session ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecureSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantSecureivrsession"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions":{"get":{"tags":["Conversations"],"summary":"Get a list of secure sessions for this participant.","description":"","operationId":"getConversationParticipantSecureivrsessions","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecureSessionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantSecureivrsessions"},"post":{"tags":["Conversations"],"summary":"Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.","description":"","operationId":"postConversationParticipantSecureivrsessions","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateSecureSession"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecureSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationParticipantSecureivrsessions"}},"/api/v2/conversations/{conversationId}/suggestions/feedback":{"post":{"tags":["Conversations"],"summary":"Suggestion feedback.","description":"","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/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: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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/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/{summaryId}/feedback":{"post":{"tags":["Conversations"],"summary":"Submit feedback for the summary.","description":"","operationId":"postConversationSummaryFeedback","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"summaryId","in":"path","description":"Summary ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FeedbackAddRequest"}}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conversation.not.found":"Invalid conversationId supplied.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:summaryFeedback:add"]},"x-purecloud-method-name":"postConversationSummaryFeedback"}},"/api/v2/integrations/credentials/{credentialId}":{"get":{"tags":["Integrations"],"summary":"Get a single credential with sensitive fields redacted","description":"","operationId":"getIntegrationsCredential","produces":["application/json"],"parameters":[{"name":"credentialId","in":"path","description":"Credential ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Credential"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["learning:coverart:upload"]},"x-purecloud-method-name":"postUploadsLearningCoverart"}},"/api/v2/uploads/workforcemanagement/historicaldata/csv":{"post":{"tags":["Uploads"],"summary":"Creates presigned url for uploading WFM historical data file. Requires data in csv format.","description":"","operationId":"postUploadsWorkforcemanagementHistoricaldataCsv","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned url successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:historicalData:upload"]},"x-purecloud-method-name":"postUploadsWorkforcemanagementHistoricaldataCsv"}},"/api/v2/uploads/publicassets/images":{"post":{"tags":["Uploads"],"summary":"Creates presigned url for uploading a public asset image","description":"","operationId":"postUploadsPublicassetsImages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned url successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["uploads:publicasset:upload"]},"x-purecloud-method-name":"postUploadsPublicassetsImages"}},"/api/v2/uploads/recordings":{"post":{"tags":["Uploads"],"summary":"Creates presigned url for uploading a recording file","description":"","operationId":"postUploadsRecordings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned url successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:recording:upload"]},"x-purecloud-method-name":"postUploadsRecordings"}},"/api/v2/dataextensions/coretypes/{coretypeName}":{"get":{"tags":["Data Extensions"],"summary":"Get a specific named core type.","description":"","operationId":"getDataextensionsCoretype","produces":["application/json"],"parameters":[{"name":"coretypeName","in":"path","description":"The core type's name","required":true,"type":"string","enum":["text","longtext","url","identifier","enum","date","datetime","integer","number","checkbox","tag"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Coretype"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["data-extensions"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getDataextensionsCoretype"}},"/api/v2/dataextensions/coretypes":{"get":{"tags":["Data Extensions"],"summary":"Get the core types from which all schemas are built.","description":"","operationId":"getDataextensionsCoretypes","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoretypeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["data-extensions"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getDataextensionsCoretypes"}},"/api/v2/dataextensions/limits":{"get":{"tags":["Data Extensions"],"summary":"Get quantitative limits on schemas","description":"","operationId":"getDataextensionsLimits","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchemaQuantityLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["data-extensions"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getDataextensionsLimits"}},"/api/v2/flows/datatables/divisionviews/{datatableId}":{"get":{"tags":["Architect"],"summary":"Returns a specific datatable by id","description":"Given a datatableId returns the datatable object and schema associated with it.","operationId":"getFlowsDatatablesDivisionview","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTable"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:datatable:search"]},"x-purecloud-method-name":"getFlowsDatatablesDivisionview"}},"/api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId}":{"get":{"tags":["Architect"],"summary":"Returns the state information about an export job","description":"Returns the state information about an export job.","operationId":"getFlowsDatatableExportJob","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"exportJobId","in":"path","description":"id of export job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableExportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableExportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","flows.datatables.session.not.found":"A session was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view","architect:datatableRow:view"]},"x-purecloud-method-name":"getFlowsDatatableExportJob"}},"/api/v2/flows/datatables/{datatableId}/export/jobs":{"post":{"tags":["Architect"],"summary":"Begin an export process for exporting all rows from a datatable","description":"Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response","operationId":"postFlowsDatatableExportJobs","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableExportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableExportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view","architect:datatableRow:view"]},"x-purecloud-method-name":"postFlowsDatatableExportJobs"}},"/api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId}":{"get":{"tags":["Architect"],"summary":"Returns the state information about an import job","description":"Returns the state information about an import job.","operationId":"getFlowsDatatableImportJob","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"importJobId","in":"path","description":"id of import job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableImportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableImportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","flows.datatables.session.not.found":"A session was not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view","architect:datatableRow:view"]},"x-purecloud-method-name":"getFlowsDatatableImportJob"}},"/api/v2/flows/datatables/{datatableId}/import/jobs":{"get":{"tags":["Architect"],"summary":"Get all recent import jobs","description":"Get all recent import jobs","operationId":"getFlowsDatatableImportJobs","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableImportEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The specified datatableId was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit","architect:datatableRow:view"]},"x-purecloud-method-name":"getFlowsDatatableImportJobs"},"post":{"tags":["Architect"],"summary":"Begin an import process for importing rows into a datatable","description":"Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response","operationId":"postFlowsDatatableImportJobs","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"in":"body","name":"body","description":"import job information","required":true,"schema":{"$ref":"#/definitions/DataTableImportJob"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableImportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableImportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit","architect:datatableRow:add"]},"x-purecloud-method-name":"postFlowsDatatableImportJobs"}},"/api/v2/flows/datatables/{datatableId}":{"get":{"tags":["Architect"],"summary":"Returns a specific datatable by id","description":"Given a datatableId returns the datatable object and schema associated with it.","operationId":"getFlowsDatatable","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTable"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"getFlowsDatatable"},"put":{"tags":["Architect"],"summary":"Updates a specific datatable by id","description":"Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.","operationId":"putFlowsDatatable","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"]},{"in":"body","name":"body","description":"datatable json-schema","required":true,"schema":{"$ref":"#/definitions/DataTable"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTable"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.cannot.remove.fields":"The updated schema had missing fields from the old schema (can't remove previously existing fields).","flows.datatables.too.many.properties":"The max number of properties allowed in a schema has been reached.","flows.datatables.schema.exception":"The schema is invalid in some way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The passed in datatable had a duplicate name."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit"]},"x-purecloud-method-name":"putFlowsDatatable"},"delete":{"tags":["Architect"],"summary":"deletes a specific datatable by id","description":"Deletes an entire datatable (including the schema and data) with a given datatableId","operationId":"deleteFlowsDatatable","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"force","in":"query","description":"force delete, even if in use","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"The datatable was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","flows.datatables.syntax.error":"There was an error parsing user data"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.possibly.in.use":"This datatable may be in use by a published flow.","flows.datatables.in.use":"This datatable is in use by a published flow."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:delete"]},"x-purecloud-method-name":"deleteFlowsDatatable"}},"/api/v2/flows/datatables/divisionviews":{"get":{"tags":["Architect"],"summary":"Retrieve a list of datatables for the org","description":"Returns a metadata list of the datatables associated with this org, including datatableId, name and description.","operationId":"getFlowsDatatablesDivisionviews","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"]},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id","enum":["id","name"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.","required":false,"type":"string","x-example":"exactMatch, beginsWith*, *endsWith, *contains*"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTablesDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:datatable:search"]},"x-purecloud-method-name":"getFlowsDatatablesDivisionviews"}},"/api/v2/flows/datatables":{"get":{"tags":["Architect"],"summary":"Retrieve a list of datatables for the org","description":"Returns a metadata list of the datatables associated with this org, including datatableId, name and description.","operationId":"getFlowsDatatables","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"]},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id","enum":["id","name"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.","required":false,"type":"string","x-example":"exactMatch, beginsWith*, *endsWith, *contains*"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTablesDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","invalid.division.id":"The division id was invalid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"getFlowsDatatables"},"post":{"tags":["Architect"],"summary":"Create a new datatable with the specified json-schema definition","description":"This will create a new datatable with fields that match the property definitions in the JSON schema. The schema's title field will be overridden by the name field in the DataTable object. See also http://json-schema.org/","operationId":"postFlowsDatatables","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"datatable json-schema","required":true,"schema":{"$ref":"#/definitions/DataTable"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTable"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","invalid.division.id":"The division id was invalid.","constraint.validation":"%s","flows.datatables.too.many.properties":"The max number of properties allowed in a schema has been reached.","flows.datatables.schema.exception":"The schema is invalid in some way","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","flows.datatables.too.many.tables":"The max number of datatables allowed has been reached.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The passed in datatable had a duplicate name."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:add"]},"x-purecloud-method-name":"postFlowsDatatables"}},"/api/v2/flows/datatables/{datatableId}/rows/{rowId}":{"get":{"tags":["Architect"],"summary":"Returns a specific row for the datatable","description":"Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.","operationId":"getFlowsDatatableRow","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"rowId","in":"path","description":"The key for the row","required":true,"type":"string"},{"name":"showbrief","in":"query","description":"if true returns just the key field for the row","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found.","flows.datatables.row.not.found":"The datatable row could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view","architect:datatableRow:view"]},"x-purecloud-method-name":"getFlowsDatatableRow"},"put":{"tags":["Architect"],"summary":"Update a row entry","description":"Updates a row with the given rowId (the value of the key field) to the new values. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs\n{\n \"Field1\": \"XYZZY\",\n \"Field2\": false,\n \"KEY\": \"27272\"\n}","operationId":"putFlowsDatatableRow","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"rowId","in":"path","description":"the key for the row","required":true,"type":"string"},{"in":"body","name":"body","description":"datatable row","required":false,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.schema.exception":"The row didn't conform to the schema in some way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found.","flows.datatables.row.not.found":"The datatable row could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The row had a duplicate keyname."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit","architect:datatableRow:edit"]},"x-purecloud-method-name":"putFlowsDatatableRow"},"delete":{"tags":["Architect"],"summary":"Delete a row entry","description":"Deletes a row with a given rowId (the value of the key field).","operationId":"deleteFlowsDatatableRow","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"rowId","in":"path","description":"the key for the row","required":true,"type":"string"}],"responses":{"204":{"description":"The row was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","flows.datatables.syntax.error":"There was an error parsing user data"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:delete","architect:datatableRow:delete"]},"x-purecloud-method-name":"deleteFlowsDatatableRow"}},"/api/v2/flows/datatables/{datatableId}/rows":{"get":{"tags":["Architect"],"summary":"Returns the rows for the datatable with the given id","description":"Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents.","operationId":"getFlowsDatatableRows","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"showbrief","in":"query","description":"If true returns just the key value of the row","required":false,"type":"boolean","default":true},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableRowEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view","architect:datatableRow:view"]},"x-purecloud-method-name":"getFlowsDatatableRows"},"post":{"tags":["Architect"],"summary":"Create a new row entry for the datatable.","description":"Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs\n{ \n \"Field1\": \"XYZZY\", \n \"Field2\": false, \n \"KEY\": \"27272\" \n}","operationId":"postFlowsDatatableRows","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"in":"body","name":"dataTableRow","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.schema.exception":"The row didn't conform to the schema in some way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","flows.datatables.too.many.rows":"The max number of datatable rows allowed has been reached.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The row had a duplicate keyname."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:add","architect:datatableRow:add"]},"x-purecloud-method-name":"postFlowsDatatableRows"}},"/api/v2/date":{"get":{"tags":["Utilities"],"summary":"Get the current system date/time","description":"","operationId":"getDate","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServerDate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getDate"}},"/api/v2/outbound/campaigns/{campaignId}/agents/{userId}":{"put":{"tags":["Outbound"],"summary":"Send notification that an agent's state changed ","description":"New agent state.","operationId":"putOutboundCampaignAgent","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"name":"userId","in":"path","description":"Agent's user ID","required":true,"type":"string"},{"in":"body","name":"body","description":"agent","required":true,"schema":{"$ref":"#/definitions/Agent"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.stage":"No stage was provided.","invalid.campaign.status":"The dialer campaign was not active.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-purecloud-method-name":"putOutboundCampaignAgent"}},"/api/v2/outbound/attemptlimits/{attemptLimitsId}":{"get":{"tags":["Outbound"],"summary":"Get attempt limits","description":"","operationId":"getOutboundAttemptlimit","produces":["application/json"],"parameters":[{"name":"attemptLimitsId","in":"path","description":"Attempt limits ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:view"]},"x-purecloud-method-name":"getOutboundAttemptlimit"},"put":{"tags":["Outbound"],"summary":"Update attempt limits","description":"","operationId":"putOutboundAttemptlimit","produces":["application/json"],"parameters":[{"name":"attemptLimitsId","in":"path","description":"Attempt limits ID","required":true,"type":"string"},{"in":"body","name":"body","description":"AttemptLimits","required":true,"schema":{"$ref":"#/definitions/AttemptLimits"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"incorrect.max.value":"Max values must be > 0 and one of them must be defined","name.cannot.be.blank":"A name must be provided.","exceeded.max.attempts.per.contact":"The maximum attempts allowed per contact is 100.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.time.zone":"Not recognized as a valid time zone.","invalid.property":"Value [%s] is not a valid property for object [%s]","exceeded.max.attempts.per.number":"The maximum attempts allowed per number is 100.","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:edit"]},"x-purecloud-method-name":"putOutboundAttemptlimit"},"delete":{"tags":["Outbound"],"summary":"Delete attempt limits","description":"","operationId":"deleteOutboundAttemptlimit","produces":["application/json"],"parameters":[{"name":"attemptLimitsId","in":"path","description":"Attempt limits ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:delete"]},"x-purecloud-method-name":"deleteOutboundAttemptlimit"}},"/api/v2/outbound/attemptlimits":{"get":{"tags":["Outbound"],"summary":"Query attempt limits list","description":"","operationId":"getOutboundAttemptlimits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimitsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:view"]},"x-purecloud-method-name":"getOutboundAttemptlimits"},"post":{"tags":["Outbound"],"summary":"Create attempt limits","description":"","operationId":"postOutboundAttemptlimits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AttemptLimits","required":true,"schema":{"$ref":"#/definitions/AttemptLimits"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"incorrect.max.value":"Max values must be > 0 and one of them must be defined","name.cannot.be.blank":"A name must be provided.","exceeded.max.attempts.per.contact":"The maximum attempts per contact limit is 100.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.time.zone":"Not recognized as a valid time zone.","invalid.property":"Value [%s] is not a valid property for object [%s]","exceeded.max.attempts.per.number":"The maximum attempts per number limit is 100.","constraint.validation":"%s","max.entity.count.reached":"The maximum attempt limits count has been reached.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:add"]},"x-purecloud-method-name":"postOutboundAttemptlimits"}},"/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer call analysis response set.","description":"","operationId":"getOutboundCallanalysisresponseset","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:view"]},"x-purecloud-method-name":"getOutboundCallanalysisresponseset"},"put":{"tags":["Outbound"],"summary":"Update a dialer call analysis response set.","description":"","operationId":"putOutboundCallanalysisresponseset","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ResponseSet","required":true,"schema":{"$ref":"#/definitions/ResponseSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.call.analysis.response.set":"The call analysis response set is invalid.","constraint.validation":"%s","invalid.call.analysis.response.set.for.agentless.campaign":"The call analysis response set is invalid for agentless campaigns.","invalid.update":"","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.flow":"The outbound flow could not be found.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:edit"]},"x-purecloud-method-name":"putOutboundCallanalysisresponseset"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer call analysis response set.","description":"","operationId":"deleteOutboundCallanalysisresponseset","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"call.analysis.response.set.in.use":"The dialer call analysis response set is in use.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:delete"]},"x-purecloud-method-name":"deleteOutboundCallanalysisresponseset"}},"/api/v2/outbound/callanalysisresponsesets":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer call analysis response sets.","description":"","operationId":"getOutboundCallanalysisresponsesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:view"]},"x-purecloud-method-name":"getOutboundCallanalysisresponsesets"},"post":{"tags":["Outbound"],"summary":"Create a dialer call analysis response set.","description":"","operationId":"postOutboundCallanalysisresponsesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ResponseSet","required":true,"schema":{"$ref":"#/definitions/ResponseSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","max.entity.count.reached":"The maximum call analysis response set count has been reached.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.flow":"The outbound flow could not be found.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:add"]},"x-purecloud-method-name":"postOutboundCallanalysisresponsesets"}},"/api/v2/outbound/callabletimesets/{callableTimeSetId}":{"get":{"tags":["Outbound"],"summary":"Get callable time set","description":"","operationId":"getOutboundCallabletimeset","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:view"]},"x-purecloud-method-name":"getOutboundCallabletimeset"},"put":{"tags":["Outbound"],"summary":"Update callable time set","description":"","operationId":"putOutboundCallabletimeset","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DialerCallableTimeSet","required":true,"schema":{"$ref":"#/definitions/CallableTimeSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.time.zone":"Not recognized as a valid time zone.","missing.time.zone":"Each callable time must have a time zone identifier.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.update":"","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.start.time":"Start time must be before stop time.","invalid.day":"Days must be within 1 - 7.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:edit"]},"x-purecloud-method-name":"putOutboundCallabletimeset"},"delete":{"tags":["Outbound"],"summary":"Delete callable time set","description":"","operationId":"deleteOutboundCallabletimeset","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","callable.time.set.in.use":"The callable time set is in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:delete"]},"x-purecloud-method-name":"deleteOutboundCallabletimeset"}},"/api/v2/outbound/callabletimesets":{"get":{"tags":["Outbound"],"summary":"Query callable time set list","description":"","operationId":"getOutboundCallabletimesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:view"]},"x-purecloud-method-name":"getOutboundCallabletimesets"},"post":{"tags":["Outbound"],"summary":"Create callable time set","description":"","operationId":"postOutboundCallabletimesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DialerCallableTimeSet","required":true,"schema":{"$ref":"#/definitions/CallableTimeSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","invalid.time.zone":"There is an unrecognized time zone.","missing.time.zone":"Each callable time must have a time zone identifier.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","max.entity.count.reached":"The maximum callable time set count has been reached.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.start.time":"Start time must be before stop time.","invalid.day":"Days must be within 1 - 7.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:add"]},"x-purecloud-method-name":"postOutboundCallabletimesets"}},"/api/v2/outbound/campaigns/{campaignId}/callback/schedule":{"post":{"tags":["Outbound"],"summary":"Schedule a Callback for a Dialer Campaign (Deprecated)","description":"This endpoint is deprecated and may have unexpected results. Please use \"/conversations/{conversationId}/participants/{participantId}/callbacks instead.\"","operationId":"postOutboundCampaignCallbackSchedule","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactCallbackRequest","required":true,"schema":{"$ref":"#/definitions/ContactCallbackRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactCallbackRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","contact.cannot.be.blank":"The contact cannot be blank.","invalid.property":"Value [%s] is not a valid property for object [%s]","contact.list.cannot.be.blank":"The contact list cannot be blank.","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","schedule.cannot.be.blank":"The schedule cannot be blank.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.contact.phone.column":"The contact phone columns are invalid.","invalid.schedule.format":"The schedule format is invalid.","callback.schedule.invalid":"The callback schedule is not valid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","callback.scheduling.error":""}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"deprecated":true,"x-purecloud-method-name":"postOutboundCampaignCallbackSchedule"}},"/api/v2/outbound/campaigns/divisionviews/{campaignId}":{"get":{"tags":["Outbound"],"summary":"Get a basic Campaign information object","description":"This returns a simplified version of a Campaign, consisting of name and division.","operationId":"getOutboundCampaignsDivisionview","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:search"]},"x-purecloud-method-name":"getOutboundCampaignsDivisionview"}},"/api/v2/outbound/campaigns/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of basic Campaign information objects","description":"This returns a simplified version of a Campaign, consisting of name and division.","operationId":"getOutboundCampaignsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDivisionViewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:search"]},"x-purecloud-method-name":"getOutboundCampaignsDivisionviews"}},"/api/v2/outbound/campaigns/{campaignId}/interactions":{"get":{"tags":["Outbound"],"summary":"Get dialer campaign interactions.","description":"","operationId":"getOutboundCampaignInteractions","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignInteractions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The specified campaignId was not found.","resource.not.found":"Resource not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignInteractions"}},"/api/v2/outbound/campaigns/{campaignId}/linedistribution":{"get":{"tags":["Outbound"],"summary":"Get line distribution information for campaigns using same Edge Group or Site as given campaign","description":"","operationId":"getOutboundCampaignLinedistribution","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"name":"includeOnlyActiveCampaigns","in":"query","description":"If true will return only active Campaigns","required":false,"type":"boolean","default":true},{"name":"edgeGroupId","in":"query","description":"Edge group to be used in line distribution calculations instead of current Campaign's Edge Group. Campaign's Site and Edge Group are mutually exclusive.","required":false,"type":"string"},{"name":"siteId","in":"query","description":"Site to be used in line distribution calculations instead of current Campaign's Site. Campaign's Site and Edge Group are mutually exclusive.","required":false,"type":"string"},{"name":"useWeight","in":"query","description":"Enable usage of weight, this value overrides current Campaign's setting in line distribution calculations","required":false,"type":"boolean"},{"name":"relativeWeight","in":"query","description":"Relative weight to be used in line distribution calculations instead of current Campaign's relative weight","required":false,"type":"integer","format":"int32"},{"name":"outboundLineCount","in":"query","description":"The number of outbound lines to be used in line distribution calculations, instead of current Campaign's Outbound Lines Count","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignOutboundLinesDistribution"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.campaign.outbound.line.count":"The outbound line count is invalid","invalid.relative.weight":"Relative weight must be between values 0 and 100 inclusively","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.campaign":"The campaign is invalid","site.has.no.active.edges":"There are no active edges in the site","invalid.property":"Value [%s] is not a valid property for object [%s]","edge.group.has.no.active.edges":"There are no active edges in the edge group","edge.group.not.found":"The edge group could not be found","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","no.edge.group.for.site":"No edge group was found for the site","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","site.and.edge.group.cannot.be.configured":"A single campaign cannot have both a site and an edge group configured"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:lineDistribution:view"]},"x-purecloud-method-name":"getOutboundCampaignLinedistribution"}},"/api/v2/outbound/campaigns/{campaignId}/progress":{"get":{"tags":["Outbound"],"summary":"Get campaign progress","description":"","operationId":"getOutboundCampaignProgress","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignProgress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignProgress"},"delete":{"tags":["Outbound"],"summary":"Reset campaign progress and recycle the campaign","description":"","operationId":"deleteOutboundCampaignProgress","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - the campaign will be recycled momentarily"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:edit","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaign"},"put":{"tags":["Outbound"],"summary":"Update a campaign.","description":"","operationId":"putOutboundCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Campaign","required":true,"schema":{"$ref":"#/definitions/Campaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"column.data.type.specification.not.found.for.contact.sort":"A column data type specification must be defined for contact sort column","invalid.priority":"The priority must be between 1 and 5 (inclusive)","name.length.exceeded":"The name length exceeds the limit of 64 characters.","invalid.column.data.type.specification.data.type":"Column data type specification data type must match the contact sort column data type","too.many.queue.members":"The limit for number of queue members on a campaign configured for agent owned records has been exceeded. See details.","duplicate.name":"The name already exists.","invalid.max.calls.per.agent":"Max calls per agent must be inside allowed range","site.has.no.active.edges":"There are no active edges in the site","edge.group.not.found":"The edge group could not be found.","too.many.data.action.conditions":"There can be a maximum of 1 data action condition across all rule sets referenced by this campaign","missing.column.data.type.specification.in.contact.list":"Column data type specifications must be defined on the campaign's contact list","contact.sorts.duplicate.field.names":"The same column name is used in separate contact sorts entries.","invalid.update":"","more.than.one.contact.list.filter":"Only one contact list filter is allowed per campaign.","managed.site.cannot.be.configured":"Managed Sites cannot be configured on a campaign.","invalid.campaign.preview.timeout.seconds":"The preview timeout seconds must be between 0 and 1200 (inclusive)","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","resources.in.use":"Resources are already in use.","cannot.update.dynamic.contact.queueing.settings":"The dynamic contact queueing settings cannot be updated","invalid.update.bad.status.transition":"The status transition is invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"The contact list filter could not be found.","dnc.list.not.found":"A do not call list could not be found.","missing.caller.id.address":"No caller id address supplied","agent.owned.column.cannot.be.changed":"The agent owned column cannot be changed.","rule.set.not.found":"A rule set could not be found.","managed.edge.group.cannot.be.configured":"Managed Edge Groups cannot be configured on a campaign.","property.not.allowed.for.external.calling":"The following properties are not allowed to be configured on an external campaign: abandonRate, edgeGroup, site, callAnalysisResponseSet, callerName, callerAddress, outboundLineCount, ruleSets, previewTimeOutSeconds, noAnswerTimeout, and callAnalysisResponseSet.","invalid.campaign.phone.columns":"The campaign phone columns are invalid.","contact.sorts.conflict":"The contact sort and contact sorts fields have conflicting values.","invalid.update.campaign.active":"The campaign is already active","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","site.not.found":"The site could not be found","queue.not.found":"The queue could not be found.","dynamic.contact.queueing.settings.cannot.be.set.for.agent.owned.campaigns":"Dynamic contact queueing cannot be enabled for agent owned campaigns","no.edge.group.for.site":"No edge group was found for the site","name.cannot.be.blank":"A name must be provided.","invalid.campaign.outbound.line.count":"","bad.request":"The request could not be understood by the server due to malformed syntax.","callable.time.set.not.found":"The callable time set could not be found.","missing.caller.id.name":"No caller id name supplied","invalid.campaign.skill.column.data.type.specifications.max.length.limit.exceeded":"The column data type specification length value exceeds the max length allowed for a skill column","constraint.validation":"%s","dnc.list.invalid.custom.exclusion.column":"The Custom Exclusion Column on one of the chosen DNC lists does not match any of the columns on the chosen Contact List","contact.list.filter.does.not.match.contact.list":"The contact list on the contact list filter does not match the contact list on the campaign.","dynamic.queueing.campaigns.count.exceeded":"The limit for dynamic queueing campaigns has been exceeded","invalid.acw.queue.setting":"Please change the After Call Work setting on the queue as Agent Requested is not valid","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","call.analysis.response.set.not.found":"The call analysis response set could not be found.","agent.owned.queue.cannot.be.changed":"The queue cannot be changed on a campaign configured for agent owned records.","script.not.found":"The script could not be found.","site.and.edge.group.cannot.be.configured":"A single campaign cannot have both a site and an edge group configured","contact.sort.field.not.found":"The contact sort field is not a column on the contact list.","invalid.campaign.agent.owned.column":"The campaign agent owned column is not a valid contact list column.","contact.sorts.invalid.field.name":"A contact sorts field name is not a valid column name in the campaign's contact list.","invalid.relative.weight":"Relative weight must be between values 0 and 100 inclusively","external.calling.property.not.allowed":"Some properties cannot be set on an external calling campaign. See details","invalid.property":"Value [%s] is not a valid property for object [%s]","edge.group.has.no.active.edges":"There are no active edges in the edge group","dynamic.queueing.active.campaigns.count.exceeded":"The limit for active dynamic queueing campaigns has been exceeded","invalid.call.analysis.response.set.for.agentless.campaign":"The call analysis response set is invalid for agentless campaigns.","invalid.ani.address":"The caller id number is invalid.","name.required":"A name must be provided.","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping.","invalid.campaign.skill.column.data.type":"The column data type specification that is selected as a skill column must be of Data Type text.","active.campaigns.limit.exceeded":"The maximum number of active campaigns has been reached. Please turn off at least one campaign and wait for it to stop before starting another one.","edge.group.is.empty":"There are no edges in the edge group","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined.","invalid.dialing.mode.update":"Invalid dialing mode","site.is.empty":"There are no edges in the site","contact.list.import.in.progress":"The contact list on the camapign is still importing contacts."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","all.campaigns.black.listed":"This organization has been blacklisted from starting campaigns. Please contact support.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","campaign.black.listed":"This campaign has been blacklisted. Please contact support."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.campaign.active":"The campaign is already active.","too.many.skill.queue.members":"The limit for number of queue members on a campaign configured for skill records has been exceeded. See details.","invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:edit"]},"x-purecloud-method-name":"putOutboundCampaign"},"delete":{"tags":["Outbound"],"summary":"Delete a campaign.","description":"","operationId":"deleteOutboundCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","campaign.in.use":"The campaign is in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:delete"]},"x-purecloud-method-name":"deleteOutboundCampaign"},"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":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:view","outbound:contact:view","routing:queue:view"]},"x-purecloud-method-name":"getOutboundCampaignAgentownedmappingpreviewResults"}},"/api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview":{"post":{"tags":["Outbound"],"summary":"Initiate request for a preview of how agents will be mapped to this campaign's contact list.","description":"","operationId":"postOutboundCampaignAgentownedmappingpreview","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.is.not.agent.owned":"This campaign is not configured for agent-owned records.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:view","outbound:contact:view","directory:user:view"]},"x-purecloud-method-name":"postOutboundCampaignAgentownedmappingpreview"}},"/api/v2/outbound/campaigns/{campaignId}/diagnostics":{"get":{"tags":["Outbound"],"summary":"Get campaign diagnostics","description":"","operationId":"getOutboundCampaignDiagnostics","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDiagnostics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignDiagnostics"}},"/api/v2/outbound/campaignrules/{campaignRuleId}":{"get":{"tags":["Outbound"],"summary":"Get Campaign Rule","description":"","operationId":"getOutboundCampaignrule","produces":["application/json"],"parameters":[{"name":"campaignRuleId","in":"path","description":"Campaign Rule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:view"]},"x-purecloud-method-name":"getOutboundCampaignrule"},"put":{"tags":["Outbound"],"summary":"Update Campaign Rule","description":"","operationId":"putOutboundCampaignrule","produces":["application/json"],"parameters":[{"name":"campaignRuleId","in":"path","description":"Campaign Rule ID","required":true,"type":"string"},{"in":"body","name":"body","description":"CampaignRule","required":true,"schema":{"$ref":"#/definitions/CampaignRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","missing.campaign.rule.conditions":"Campaign rule must have a condition.","invalid.campaign.rule.action.parameter":"Campaign rule action has an invalid parameter.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","missing.campaign.rule.condition.value":"Campaign rule condition must have an value.","missing.campaign.rule.entity":"Campaign rule must have an entity for conditions.","missing.campaign.rule.action.parameters":"Campaign rule action must have a parameter.","invalid.campaign.rule.condition.parameter":"Campaign rule condition has an invalid parameter.","constraint.validation":"%s","missing.campaign.rule.condition.type":"Campaign rule condition must have a type.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.campaign.rule.condition.value":"Campaign rule condition has an invalid value.","missing.campaign.rule.actions":"Campaign rule must have an action.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","missing.campaign.rule.action.entity":"Campaign rule must have an action entity.","incorrect.max.value":"Max values must be > 0 and one of them must be defined","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.campaign.rule.condition.operator":"Campaign rule condition has an invalid operator.","cannot.modify.enabled.campaign.rule":"Cannot modify a rule that is enabled.","missing.campaign.rule.condition.parameters":"Campaign rule condition must have a parameter.","missing.campaign.rule.action.type":"Campaign rule action must have a type.","invalid.external.campaign.dialingmode.transition":"Cannot change to/from external dialing mode to/from another dialing mode.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.campaign.rule.condition.operator":"Campaign rule condition must have an operator."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:edit"]},"x-purecloud-method-name":"putOutboundCampaignrule"},"delete":{"tags":["Outbound"],"summary":"Delete Campaign Rule","description":"","operationId":"deleteOutboundCampaignrule","produces":["application/json"],"parameters":[{"name":"campaignRuleId","in":"path","description":"Campaign Rule ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","cannot.delete.enabled.campaign.rule":"Cannot delete a rule that is enabled."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:delete"]},"x-purecloud-method-name":"deleteOutboundCampaignrule"}},"/api/v2/outbound/campaignrules":{"get":{"tags":["Outbound"],"summary":"Query Campaign Rule list","description":"","operationId":"getOutboundCampaignrules","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRuleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:view"]},"x-purecloud-method-name":"getOutboundCampaignrules"},"post":{"tags":["Outbound"],"summary":"Create Campaign Rule","description":"","operationId":"postOutboundCampaignrules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CampaignRule","required":true,"schema":{"$ref":"#/definitions/CampaignRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","cannot.create.enabled.campaign.rule":"Cannot create a rule that is enabled.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","missing.campaign.rule.conditions":"Campaign rule must have a condition.","invalid.campaign.rule.action.parameter":"Campaign rule action has an invalid parameter.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","missing.campaign.rule.condition.value":"Campaign rule condition must have an value.","missing.campaign.rule.entity":"Campaign rule must have an entity for conditions.","missing.campaign.rule.action.parameters":"Campaign rule action must have a parameter.","invalid.campaign.rule.condition.parameter":"Campaign rule condition has an invalid parameter.","constraint.validation":"%s","missing.campaign.rule.condition.type":"Campaign rule condition must have a type.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.campaign.rule.condition.value":"Campaign rule condition has an invalid value.","invalid.turn.on.campaign.action":"Campaign rule action cannot turn on a campaign/sequence based on that campaign/sequence's progress or agent count.","missing.campaign.rule.actions":"Campaign rule must have an action.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","missing.campaign.rule.action.entity":"At least one rule action entity is required.","incorrect.max.value":"Max values must be > 0 and one of them must be defined","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.campaign.rule.condition.operator":"Campaign rule condition has an invalid operator.","missing.campaign.rule.condition.parameters":"Campaign rule condition must have a parameter.","max.entity.count.reached":"The maximum campaign rule count has been reached.","missing.campaign.rule.action.type":"Campaign rule action must have a type.","invalid.external.campaign.dialingmode.transition":"Cannot change to/from external dialing mode to/from another dialing mode.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.dialing.mode.update":"Invalid dialing mode specified.","missing.campaign.rule.condition.operator":"Campaign rule condition must have an operator."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:add"]},"x-purecloud-method-name":"postOutboundCampaignrules"}},"/api/v2/outbound/schedules/campaigns/{campaignId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer campaign schedule.","description":"","operationId":"getOutboundSchedulesCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesCampaign"},"put":{"tags":["Outbound"],"summary":"Update a new campaign schedule.","description":"","operationId":"putOutboundSchedulesCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"CampaignSchedule","required":true,"schema":{"$ref":"#/definitions/CampaignSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.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.","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:edit"]},"x-purecloud-method-name":"putOutboundSchedulesCampaign"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer campaign schedule.","description":"","operationId":"deleteOutboundSchedulesCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:delete"]},"x-purecloud-method-name":"deleteOutboundSchedulesCampaign"}},"/api/v2/outbound/schedules/campaigns":{"get":{"tags":["Outbound"],"summary":"Query for a list of dialer campaign schedules.","description":"","operationId":"getOutboundSchedulesCampaigns","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignSchedule"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesCampaigns"}},"/api/v2/outbound/campaigns/{campaignId}/stats":{"get":{"tags":["Outbound"],"summary":"Get statistics about a Dialer Campaign","description":"","operationId":"getOutboundCampaignStats","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignStats"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignStats"}},"/api/v2/outbound/campaigns/progress":{"post":{"tags":["Outbound"],"summary":"Get progress for a list of campaigns","description":"","operationId":"postOutboundCampaignsProgress","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Campaign IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignProgress"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.missing.callback.numbers":"Callback numbers missing","callback.error.missing.queue.id":"Callback missing queue ID","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"postOutboundCampaignsProgress"}},"/api/v2/outbound/campaigns":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer campaigns.","description":"","operationId":"getOutboundCampaigns","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"contactListId","in":"query","description":"Contact List ID","required":false,"type":"string"},{"name":"dncListIds","in":"query","description":"DNC list ID","required":false,"type":"string"},{"name":"distributionQueueId","in":"query","description":"Distribution queue ID","required":false,"type":"string"},{"name":"edgeGroupId","in":"query","description":"Edge group ID","required":false,"type":"string"},{"name":"callAnalysisResponseSetId","in":"query","description":"Call analysis response set ID","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 campaigns can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaigns"},"post":{"tags":["Outbound"],"summary":"Create a campaign.","description":"","operationId":"postOutboundCampaigns","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Campaign","required":true,"schema":{"$ref":"#/definitions/Campaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"column.data.type.specification.not.found.for.contact.sort":"A column data type specification must be defined for contact sort column","invalid.priority":"The priority must be between 1 and 5 (inclusive)","name.length.exceeded":"The name length exceeds the limit of 64 characters.","invalid.column.data.type.specification.data.type":"Column data type specification data type must match the contact sort column data type","too.many.queue.members":"The limit for number of queue members on a campaign configured for agent owned records has been exceeded. See details.","duplicate.name":"The name already exists.","invalid.max.calls.per.agent":"Max calls per agent must be inside allowed range","site.has.no.active.edges":"There are no active edges in the site","edge.group.not.found":"The edge group could not be found.","too.many.data.action.conditions":"There can be a maximum of 1 data action condition across all rule sets referenced by this campaign","missing.column.data.type.specification.in.contact.list":"Column data type specifications must be defined on the campaign's contact list","contact.sorts.duplicate.field.names":"The same column name is used in separate contact sorts entries.","invalid.agent.owned.dialing.mode":"Agent owned records are only available for the Preview dialing mode.","more.than.one.contact.list.filter":"Only one contact list filter is allowed per campaign.","managed.site.cannot.be.configured":"Managed Sites cannot be configured on a campaign.","invalid.campaign.preview.timeout.seconds":"The preview timeout seconds must be between 0 and 1200 (inclusive)","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","cannot.update.dynamic.contact.queueing.settings":"Dynamic queueing cannot be changed once it's set","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"The contact list filter could not be found.","dnc.list.not.found":"A do not call list could not be found.","missing.caller.id.address":"No caller id address supplied","rule.set.not.found":"A rule set could not be found.","managed.edge.group.cannot.be.configured":"Managed Edge Groups cannot be configured on a campaign.","property.not.allowed.for.external.calling":"Property is not allowed for external calling","max.entity.count.reached":"The maximum campaign count has been reached.","invalid.campaign.phone.columns":"The campaign phone columns are invalid.","contact.sorts.conflict":"The contact sort and contact sorts fields have conflicting values.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","site.not.found":"The site could not be found","queue.not.found":"The queue could not be found.","dynamic.contact.queueing.settings.cannot.be.set.for.agent.owned.campaigns":"Dynamic contact queueing cannot be enabled for agent owned campaigns","no.edge.group.for.site":"No edge group was found for the site","name.cannot.be.blank":"A name must be provided.","missing.contact.list.filter":"A contact list filter must be provided when dynamic filtering is enabled.","invalid.campaign.outbound.line.count":"","bad.request":"The request could not be understood by the server due to malformed syntax.","callable.time.set.not.found":"The callable time set could not be found.","invalid.create":"","missing.caller.id.name":"No caller id name supplied","invalid.campaign.skill.column.data.type.specifications.max.length.limit.exceeded":"The column data type specification length value exceeds the max length allowed for a skill column","constraint.validation":"%s","dnc.list.invalid.custom.exclusion.column":"The Custom Exclusion Column on one of the chosen DNC lists does not match any of the columns on the chosen Contact List","contact.list.filter.does.not.match.contact.list":"The contact list on the contact list filter does not match the contact list on the campaign.","dynamic.queueing.campaigns.count.exceeded":"The limit for dynamic queueing campaigns has been exceeded","invalid.acw.queue.setting":"Please change the After Call Work setting on the queue as Agent Requested is not valid","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","call.analysis.response.set.not.found":"The call analysis response set could not be found.","script.not.found":"The script could not be found.","site.and.edge.group.cannot.be.configured":"A single campaign cannot have both a site and an edge group configured","contact.sort.field.not.found":"The contact sort field is not a column on the contact list.","invalid.campaign.agent.owned.column":"The campaign agent owned column is not a valid contact list column.","contact.sorts.invalid.field.name":"A contact sorts field name is not a valid column name in the campaign's contact list.","invalid.relative.weight":"Relative weight must be between values 0 and 100 inclusively","external.calling.property.not.allowed":"Some properties cannot be set on an external calling campaign. See details","invalid.property":"Value [%s] is not a valid property for object [%s]","edge.group.has.no.active.edges":"There are no active edges in the edge group","dynamic.queueing.active.campaigns.count.exceeded":"The limit for active dynamic queueing campaigns has been exceeded","invalid.ani.address":"The caller id number is invalid.","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping.","invalid.campaign.skill.column.data.type":"The column data type specification that is selected as a skill column must be of Data Type text.","edge.group.is.empty":"There are no edges in the edge group","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined.","invalid.dialing.mode.update":"A campaign may not be updated to or from external dialing mode to any other dialing mode.","site.is.empty":"There are no edges in the site"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.skill.queue.members":"The limit for number of queue members on a campaign configured for skill records has been exceeded. See details."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:add"]},"x-purecloud-method-name":"postOutboundCampaigns"}},"/api/v2/outbound/campaigns/all/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query across all types of campaigns","description":"","operationId":"getOutboundCampaignsAllDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"Campaign ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Campaign name(s)","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"mediaType","in":"query","description":"Media type(s)","required":false,"type":"array","items":{"type":"string","enum":["email","sms","voice"]},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonCampaignDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.filter.field":"Invalid query parameter supplied for filtering.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:search","outbound:messagingCampaign:search","outbound:emailCampaign:search"]},"x-purecloud-method-name":"getOutboundCampaignsAllDivisionviews"}},"/api/v2/outbound/campaigns/all":{"get":{"tags":["Outbound"],"summary":"Query across all types of campaigns by division","description":"","operationId":"getOutboundCampaignsAll","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"Campaign ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Campaign name(s)","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"mediaType","in":"query","description":"Media type(s)","required":false,"type":"array","items":{"type":"string","enum":["email","sms","voice"]},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonCampaignEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.filter.field":"Invalid query parameter supplied for filtering.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view","outbound:messagingCampaign:view","outbound:emailCampaign:view"]},"x-purecloud-method-name":"getOutboundCampaignsAll"}},"/api/v2/outbound/contactlists/divisionviews/{contactListId}":{"get":{"tags":["Outbound"],"summary":"Get a basic ContactList information object","description":"This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size.","operationId":"getOutboundContactlistsDivisionview","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contactlist ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contactList:search"]},"x-purecloud-method-name":"getOutboundContactlistsDivisionview"}},"/api/v2/outbound/contactlists/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of simplified contact list objects.","description":"This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size.","operationId":"getOutboundContactlistsDivisionviews","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListDivisionViewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 contact lists can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contactList:search"]},"x-purecloud-method-name":"getOutboundContactlistsDivisionviews"}},"/api/v2/outbound/contactlists/{contactListId}/export":{"get":{"tags":["Outbound"],"summary":"Get the URI of a contact list export.","description":"","operationId":"getOutboundContactlistExport","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"name":"download","in":"query","description":"Redirect to download uri","required":false,"type":"string","default":"false"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportUri"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","exports.black.listed":"This organization has been prohibited from exporting contact lists. Please contact support.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","no.available.list.export.uri":"There is no available download URI for contact list at this time.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contact:view","outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlistExport"},"post":{"tags":["Outbound"],"summary":"Initiate the export of a contact list.","description":"Returns 200 if received OK.","operationId":"postOutboundContactlistExport","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Export information to get","required":false,"schema":{"$ref":"#/definitions/ContactsExportRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityRef"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","contact.list.export.in.progress":"An export is already in progress for this contact list.","internal.error":"An internal service error occurred.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.contact.list.filter":"The contact list filter provided is not valid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","exports.black.listed":"This organization has been prohibited from exporting contact lists. Please contact support.","contact.list.import.in.progress":"The contact list cannot be exported while it is being imported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contact:view","outbound:contactList:view"]},"x-purecloud-method-name":"postOutboundContactlistExport"}},"/api/v2/outbound/contactlistfilters/preview":{"post":{"tags":["Outbound"],"summary":"Get a preview of the output of a contact list filter","description":"","operationId":"postOutboundContactlistfiltersPreview","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactListFilter","required":true,"schema":{"$ref":"#/definitions/ContactListFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FilterPreviewResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:view"]},"x-purecloud-method-name":"postOutboundContactlistfiltersPreview"}},"/api/v2/outbound/contactlistfilters/{contactListFilterId}":{"get":{"tags":["Outbound"],"summary":"Get Contact list filter","description":"","operationId":"getOutboundContactlistfilter","produces":["application/json"],"parameters":[{"name":"contactListFilterId","in":"path","description":"Contact List Filter ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:view"]},"x-purecloud-method-name":"getOutboundContactlistfilter"},"put":{"tags":["Outbound"],"summary":"Update Contact List Filter","description":"","operationId":"putOutboundContactlistfilter","produces":["application/json"],"parameters":[{"name":"contactListFilterId","in":"path","description":"Contact List Filter ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactListFilter","required":true,"schema":{"$ref":"#/definitions/ContactListFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"operator.required":"Could not update the contact list filter because the operator field was empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","contact.list.not.found":"Could not update the contact list filter because the contact list could not be found.","filter.type.required.for.multiple.predicates":"Could not update the contact list filter because the filter type on a clause is required if there are multiple predicates.","constraint.validation":"%s","filter.type.required.for.multiple.clauses":"Could not update the contact list filter because the filter type is required if there are multiple clauses.","at.least.one.predicate.required":"Could not update the contact list filter because each clause must contain at least one predicate.","value.required":"Could not update the contact list filter because the value field on a predicate was empty and required for that predicate's operator.","range.max.required":"Could not update the contact list filter because the range max field is required for Between operator.","filter.modification.in.progress":"Could not update the contact list filter because filter modification is in progress.","value.did.not.match.column.type":"Could not update the contact list filter because the predicate value field did not match the column type.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","value.exceeds.max.digits":"The maximum number of digits for the value on a predicate with a numeric operator has been exceeded.","max.less.than.min":"Could not update the contact list filter because the predicate range max value is less than the min value.","min.did.not.match.column.type":"Could not update the contact list filter because the predicate range min field did not match the column type.","value.exceeds.max.decimal.places":"The maximum number of decimal places in the value on a predicate with a numeric operator has been exceeded.","cannot.edit.contact.list.filter.source.type":"Could not update the contact list filter because the source type can not be edited.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","column.does.not.match.contact.list":"Could not update the contact list filter because the column on a predicate did not match a column on the selected contact list.","contact.list.template.not.found":"Could not update the contact list filter because the contact list template could not be found.","range.required":"Could not update the contact list filter because the range field was empty and is required for Between and In operators.","max.predicates.contains.exceeded":"Could not update the contact list filter because the maximum number of predicates with CONTAINS operators has been exceeded.","invalid.property":"Value [%s] is not a valid property for object [%s]","contact.list.cannot.be.blank":"Could not update the contact list filter because the contact list field was blank when source type is ContactList.","invalid.date.value":"Could not update the contact list filter because the value field on the predicate is not a valid date.","clauses.required":"Could not update the contact list filter because the clauses field is required to contain at least one clause.","max.did.not.match.column.type":"Could not update the contact list filter because the predicate range max field did not match the column type.","invalid.contact.list.filter.source.type":"Could not update the contact list filter because the source type is invalid.","column.required":"Could not update the contact list filter because the column field was empty on a predicate.","max.predicates.exceeded":"Could not update the contact list filter because the maximum number of predicates has been exceeded.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.list.template.required":"Could not update the contact list filter because the contact list template field was blank when source type is ContactListTemplate.","range.set.required":"Could not update the contact list filter because the range set field is required for In operator.","range.min.required":"Could not update the contact list filter because the range min field is required for Between operator."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:edit"]},"x-purecloud-method-name":"putOutboundContactlistfilter"},"delete":{"tags":["Outbound"],"summary":"Delete Contact List Filter","description":"","operationId":"deleteOutboundContactlistfilter","produces":["application/json"],"parameters":[{"name":"contactListFilterId","in":"path","description":"Contact List Filter ID","required":true,"type":"string"}],"responses":{"204":{"description":"Contact list filter deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:delete"]},"x-purecloud-method-name":"deleteOutboundContactlistfilter"}},"/api/v2/outbound/contactlistfilters/bulk/retrieve":{"post":{"tags":["Outbound"],"summary":"Retrieve multiple contact list filters","description":"","operationId":"postOutboundContactlistfiltersBulkRetrieve","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The contact list filters to retrieve","required":true,"schema":{"$ref":"#/definitions/ContactListFilterBulkRetrieveBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilterEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"No body with contact list filter ids was provided in request.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:view"]},"x-purecloud-method-name":"postOutboundContactlistfiltersBulkRetrieve"}},"/api/v2/outbound/contactlistfilters":{"get":{"tags":["Outbound"],"summary":"Query Contact list filters","description":"","operationId":"getOutboundContactlistfilters","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]},{"name":"contactListId","in":"query","description":"Contact List ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilterEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:view"]},"x-purecloud-method-name":"getOutboundContactlistfilters"},"post":{"tags":["Outbound"],"summary":"Create Contact List Filter","description":"","operationId":"postOutboundContactlistfilters","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactListFilter","required":true,"schema":{"$ref":"#/definitions/ContactListFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"operator.required":"Could not update the contact list filter because the operator field was empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","contact.list.not.found":"Could not create the contact list filter because the contact list could not be found.","filter.type.required.for.multiple.predicates":"Could not update the contact list filter because the filter type on a clause is required if there are multiple predicates.","constraint.validation":"%s","filter.type.required.for.multiple.clauses":"Could not update the contact list filter because the filter type is required if there are multiple clauses.","at.least.one.predicate.required":"Could not update the contact list filter because each clause must contain at least one predicate.","value.required":"Could not update the contact list filter because the value field on a predicate was empty and required for that predicate's operator.","range.max.required":"Could not update the contact list filter because the range max field is required for Between operator.","value.did.not.match.column.type":"Could not update the contact list filter because the predicate value field did not match the column type.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","value.exceeds.max.digits":"The maximum number of digits for the value on a predicate with a numeric operator has been exceeded.","max.less.than.min":"Could not update the contact list filter because the predicate range max value is less than the min value.","min.did.not.match.column.type":"Could not update the contact list filter because the predicate range min field did not match the column type.","value.exceeds.max.decimal.places":"The maximum number of decimal places in the value on a predicate with a numeric operator has been exceeded.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","column.does.not.match.contact.list":"Could not update the contact list filter because the column on a predicate did not match a column on the selected contact list.","contact.list.template.not.found":"Could not create the contact list filter because the contact list template could not be found.","range.required":"Could not update the contact list filter because the range field was empty and is required for Between and In operators.","max.predicates.contains.exceeded":"Could not create the contact list filter because the maximum number of predicates with CONTAINS operators has been exceeded.","invalid.property":"Value [%s] is not a valid property for object [%s]","contact.list.cannot.be.blank":"Could not create the contact list filter because the contact list field was blank when source type is ContactList.","invalid.date.value":"Could not update the contact list filter because the value field on the predicate is not a valid date.","clauses.required":"Could not update the contact list filter because the clauses field is required to contain at least one clause.","max.did.not.match.column.type":"Could not update the contact list filter because the predicate range max field did not match the column type.","invalid.contact.list.filter.source.type":"Could not create the contact list filter because the source type is invalid.","column.required":"Could not update the contact list filter because the column field was empty on a predicate.","max.entity.count.reached":"The maximum contact list filter count has been reached.","max.predicates.exceeded":"Could not create the contact list filter because the maximum number of predicates has been exceeded.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.list.template.required":"Could not create the contact list filter because the contact list template field was blank when source type is ContactListTemplate.","range.set.required":"Could not update the contact list filter because the range set field is required for In operator.","range.min.required":"Could not update the contact list filter because the range min field is required for Between operator."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:add"]},"x-purecloud-method-name":"postOutboundContactlistfilters"}},"/api/v2/outbound/contactlists/{contactListId}/importstatus":{"get":{"tags":["Outbound"],"summary":"Get dialer contactList import status.","description":"","operationId":"getOutboundContactlistImportstatus","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlistImportstatus"}},"/api/v2/outbound/contactlists/{contactListId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer contact list.","description":"","operationId":"getOutboundContactlist","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The dialer contact list was not found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlist"},"put":{"tags":["Outbound"],"summary":"Update a contact list.","description":"","operationId":"putOutboundContactlist","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactList","required":true,"schema":{"$ref":"#/definitions/ContactList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","contact.columns.do.not.contain.phone.number.column":"The contact columns do not contain one or more of the specified phone number columns","no.phone.columns":"No phone columns provided","name.length.exceeded":"The name length exceeds the limit of 64 characters.","system.column.phone.column":"ContactList Phone column cannot be a system defined column name.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","not.unique.email.columns":"Email Columns contain duplicate values.","missing.column.data.type.specification.max":"The numeric column data type specifications max value is required.","missing.column.data.type.specification.in.contact.list":"Column data type specifications must be provided for all columns","no.contact.columns.defined":"There are no contact columns defined.","constraint.validation":"%s","contact.list.both.phone.email.column.empty":"Contact list phone and email columns are empty.","invalid.contact.email.column":"At least one email column is required, and all email columns must have a columnName and type.","invalid.update":"","invalid.column.data.type.specifications.max.length.values":"The text column data type specifications max length value is invalid","cannot.update.email.columns":"The email columns can not be updated.","not.unique.contact.columns":"Contact Columns contains duplicate values.","missing.column.data.type.specification.min":"The numeric column data type specifications min value is required.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","cannot.have.callable.time.column.with.automatic.time.zone.mapping":"The phone columns cannot reference callable time columns when automatic time zone mapping is being used","cannot.update.phone.columns":"The phone columns can not be updated.","invalid.contact.phone.column":"At least one phone column is required, and all phone columns must have a columnName and type.","invalid.zip.code.column":"The zip code column must be a column of the contact list and cannot be a phone column","contact.columns.do.not.contain.email.column":"The contact columns do not contain one or more of the specified email addresses columns","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.columns.limit.exceeded":"Number of email columns must not exceed the limit.","contact.columns.dont.match":"Contact columns field and ordered contact columns field must match.","column.data.type.specifications.summed.maxlength.exceeds.maximum.allowed":"The sum of maxlength for all column data type specifications text columns exceeds the maximum allowed.","invalid.column.data.type.specifications.max.values":"The numeric column data type specifications max value is invalid.","cannot.edit.automatic.time.zone.mapping.settings":"Automatic time zone mapping and the zip code column cannot be changed after contact list creation","not.unique.phone.columns":"Phone Number Columns contain duplicate values.","invalid.property":"Value [%s] is not a valid property for object [%s]","no.email.columns":"No email columns provided","phone.columns.limit.exceeded":"Number of phone columns must not exceed the limit.","column.data.type.specification.column.name.not.found":"Column data type specification column name is not a valid contact list column","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","cannot.update.column.data.type.specifications":"The column data type specifications cannot be updated.","cannot.have.zip.code.column.without.automatic.time.zone.mapping":"The zip code column can only be used when automatic time zone mapping is also being used","invalid.contact.data.value":"The contact data values are invalid.","invalid.column.data.type.specifications.min.values":"The numeric column data type specifications min value is invalid.","contact.list.email.columns.not.supported":"Contact list email columns are not supported.","missing.column.data.type.specification.max.length":"The numeric column data type specifications max length value is required.","cannot.update.contact.column.names":"The contact column names can not be updated."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:edit"]},"x-purecloud-method-name":"putOutboundContactlist"},"delete":{"tags":["Outbound"],"summary":"Delete a contact list.","description":"","operationId":"deleteOutboundContactlist","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","internal.error":"An internal server error occurred.","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","contact.list.import.in.progress":"The contact list import is in progress.","contact.list.in.use":"The contact list is in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:delete"]},"x-purecloud-method-name":"deleteOutboundContactlist"}},"/api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview":{"get":{"tags":["Outbound"],"summary":"Preview the result of applying Automatic Time Zone Mapping to a contact list","description":"","operationId":"getOutboundContactlistTimezonemappingpreview","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeZoneMappingPreview"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.automatic.time.zone.mapping":"This contact list is not set up for Automatic Time Zone Mapping","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The contact list could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlistTimezonemappingpreview"}},"/api/v2/outbound/contactlisttemplates/{contactListTemplateId}":{"get":{"tags":["Outbound"],"summary":"Get Contact List Template","description":"","operationId":"getOutboundContactlisttemplate","produces":["application/json"],"parameters":[{"name":"contactListTemplateId","in":"path","description":"ContactListTemplate ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:view"]},"x-purecloud-method-name":"getOutboundContactlisttemplate"},"put":{"tags":["Outbound"],"summary":"Update a contact list template.","description":"","operationId":"putOutboundContactlisttemplate","produces":["application/json"],"parameters":[{"name":"contactListTemplateId","in":"path","description":"ContactListTemplate ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactListTemplate","required":true,"schema":{"$ref":"#/definitions/ContactListTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","no.phone.columns":"No phone columns provided","name.length.exceeded":"The name length exceeds the limit of 64 characters.","missing.column.data.type.specification.in.contact.list.template":"Column data type specifications must be provided for all columns","system.column.phone.column":"ContactList Phone column cannot be a system defined column name.","bad.request":"The request could not be understood by the server due to malformed syntax.","not.unique.email.columns":"Email Columns contain duplicate values.","missing.column.data.type.specification.max":"The numeric column data type specifications max value is required.","no.contact.columns.defined":"There are no contact columns defined.","constraint.validation":"%s","invalid.contact.email.column":"At least one email column is required, and all email columns must have a columnName and type.","invalid.update":"","invalid.column.data.type.specifications.max.length.values":"The text column data type specifications max length value is invalid","cannot.update.email.columns":"The email columns cannot be updated.","contact.column.length.limit.exceeded":"The length of each contact column must not exceed the limit.","not.unique.contact.columns":"Contact Columns contains duplicate values.","contact.list.template.email.columns.not.supported":"Contact list template email columns are not supported.","missing.column.data.type.specification.min":"The numeric column data type specifications min value is required.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","cannot.have.callable.time.column.with.automatic.time.zone.mapping":"The phone columns cannot reference callable time columns when automatic time zone mapping is being used","cannot.update.phone.columns":"The phone columns cannot be updated.","invalid.contact.phone.column":"At least one phone column is required, and all phone columns must have a columnName and type.","invalid.zip.code.column":"The zip code column must be a column of the contact list template and cannot be a phone column","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.columns.limit.exceeded":"Number of email columns must not exceed the limit.","column.data.type.specifications.summed.maxlength.exceeds.maximum.allowed":"The sum of maxlength for all column data type specifications text columns exceeds the maximum allowed.","invalid.column.data.type.specifications.max.values":"The numeric column data type specifications max value is invalid.","cannot.edit.automatic.time.zone.mapping.settings":"Automatic time zone mapping and the zip code column cannot be changed after contact list creation","not.unique.phone.columns":"Phone Number Columns contain duplicate values.","invalid.property":"Value [%s] is not a valid property for object [%s]","no.email.columns":"No email columns provided","contact.list.template.both.phone.email.column.empty":"Contact list template phone and email columns are empty.","phone.columns.limit.exceeded":"Number of phone columns must not exceed the limit.","column.data.type.specification.column.name.not.found":"Column data type specification column name is not a valid contact list template column","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","cannot.update.column.data.type.specifications":"The column data type specifications cannot be updated.","contact.columns.limit.exceeded":"Number of contact columns must not exceed the limit.","cannot.have.zip.code.column.without.automatic.time.zone.mapping":"The zip code column can only be used when automatic time zone mapping is also being used","invalid.column.data.type.specifications.min.values":"The numeric column data type specifications min value is invalid.","missing.column.data.type.specification.max.length":"The numeric column data type specifications max length value is required.","cannot.update.contact.column.names":"The contact column names cannot be updated."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"duplicate.name":"The name already exists.","invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:edit"]},"x-purecloud-method-name":"putOutboundContactlisttemplate"},"delete":{"tags":["Outbound"],"summary":"Delete Contact List Template","description":"","operationId":"deleteOutboundContactlisttemplate","produces":["application/json"],"parameters":[{"name":"contactListTemplateId","in":"path","description":"ContactListTemplate ID","required":true,"type":"string"}],"responses":{"204":{"description":"Contact list template deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:delete"]},"x-purecloud-method-name":"deleteOutboundContactlisttemplate"}},"/api/v2/outbound/contactlisttemplates":{"get":{"tags":["Outbound"],"summary":"Query a list of contact list templates","description":"","operationId":"getOutboundContactlisttemplates","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListTemplateEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:view"]},"x-purecloud-method-name":"getOutboundContactlisttemplates"},"post":{"tags":["Outbound"],"summary":"Create Contact List Template","description":"","operationId":"postOutboundContactlisttemplates","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactListTemplate","required":true,"schema":{"$ref":"#/definitions/ContactListTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","no.phone.columns":"No phone columns provided","name.length.exceeded":"The name length exceeds the limit of 64 characters.","missing.column.data.type.specification.in.contact.list.template":"Column data type specifications must be provided for all columns","system.column.phone.column":"ContactList Phone column cannot be a system defined column name.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"","not.unique.email.columns":"Email Columns contain duplicate values.","missing.column.data.type.specification.max":"The numeric column data type specifications max value is required.","constraint.validation":"%s","invalid.column.data.type.specifications.max.length.values":"The text column data type specifications max length value is invalid.","contact.list.template.email.columns.not.supported":"Contact list template email columns not supported.","missing.column.data.type.specification.min":"The numeric column data type specifications min value is required.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","cannot.have.callable.time.column.with.automatic.time.zone.mapping":"The phone columns cannot reference callable time columns when automatic time zone mapping is being used","invalid.zip.code.column":"The zip code column must be a column of the contact list template and cannot be a phone column","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.columns.limit.exceeded":"Number of email columns must not exceed the limit.","column.data.type.specifications.summed.maxlength.exceeds.maximum.allowed":"The sum of maxlength for all column data type specifications text columns exceeds the maximum allowed.","invalid.column.data.type.specifications.max.values":"The numeric column data type specifications max value is invalid.","not.unique.phone.columns":"Phone Number Columns contain duplicate values.","invalid.property":"Value [%s] is not a valid property for object [%s]","no.email.columns":"No email columns provided","contact.list.template.both.phone.email.column.empty":"Contact list template phone and email columns are empty.","max.entity.count.reached":"The maximum contact list template count has been reached.","phone.columns.limit.exceeded":"Number of phone columns must not exceed the limit.","column.data.type.specification.column.name.not.found":"Column data type specification column name is not a valid contact list template column","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","cannot.have.zip.code.column.without.automatic.time.zone.mapping":"The zip code column can only be used when automatic time zone mapping is also being used","invalid.column.data.type.specifications.min.values":"The numeric column data type specifications min value is invalid.","missing.column.data.type.specification.max.length":"The numeric column data type specifications max length value is required."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"duplicate.name":"The name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:add"]},"x-purecloud-method-name":"postOutboundContactlisttemplates"},"delete":{"tags":["Outbound"],"summary":"Delete multiple contact list templates.","description":"","operationId":"deleteOutboundContactlisttemplates","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"contact list template id(s) to delete","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"Contact list templates accepted for delete."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deletes":"There were too many contact list templates in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:delete"]},"x-purecloud-method-name":"deleteOutboundContactlisttemplates"}},"/api/v2/outbound/contactlisttemplates/bulk/add":{"post":{"tags":["Outbound"],"summary":"Add multiple contact list templates","description":"","operationId":"postOutboundContactlisttemplatesBulkAdd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"contact list template(s) to add","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ContactListTemplate"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListTemplateEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.contact.list.templates.added":"The number of contact list templates being added exceeds the limit","bad.request":"No contact list templates were provided in request.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:add"]},"x-purecloud-method-name":"postOutboundContactlisttemplatesBulkAdd"}},"/api/v2/outbound/contactlisttemplates/bulk/retrieve":{"post":{"tags":["Outbound"],"summary":"Get multiple contact list templates","description":"","operationId":"postOutboundContactlisttemplatesBulkRetrieve","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"contact list templates to get","required":true,"schema":{"$ref":"#/definitions/ContactListTemplateBulkRetrieveBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListTemplateEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"No contact list template ids were provided in request.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:view"]},"x-purecloud-method-name":"postOutboundContactlisttemplatesBulkRetrieve"}},"/api/v2/outbound/contactlists":{"get":{"tags":["Outbound"],"summary":"Query a list of contact lists.","description":"","operationId":"getOutboundContactlists","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 contact lists can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlists"},"post":{"tags":["Outbound"],"summary":"Create a contact List.","description":"","operationId":"postOutboundContactlists","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactList","required":true,"schema":{"$ref":"#/definitions/ContactList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","contact.columns.do.not.contain.phone.number.column":"The contact columns do not contain phone number column","no.phone.columns":"No phone columns provided","name.length.exceeded":"The name length exceeds the limit of 64 characters.","system.column.phone.column":"ContactList Phone column cannot be a system defined column name.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","not.unique.email.columns":"Email Columns contain duplicate values.","missing.column.data.type.specification.max":"The numeric column data type specifications max value is required.","missing.column.data.type.specification.in.contact.list":"Column data type specifications must be provided for all columns","division.not.found":"The division could not be found.","no.contact.columns.defined":"There are no contact columns defined.","constraint.validation":"%s","contact.list.both.phone.email.column.empty":"Contact list phone and email columns are empty.","invalid.contact.email.column":"The contact email columns are invalid.","invalid.column.data.type.specifications.max.length.values":"The text column data type specifications max length value is invalid.","contact.column.length.limit.exceeded":"The length of each contact column must not exceed the limit.","not.unique.contact.columns":"Contact Columns contains duplicate values.","missing.column.data.type.specification.min":"The numeric column data type specifications min value is required.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","cannot.have.callable.time.column.with.automatic.time.zone.mapping":"The phone columns cannot reference callable time columns when automatic time zone mapping is being used","invalid.contact.phone.column":"The contact phone columns are invalid.","invalid.zip.code.column":"The zip code column must be a column of the contact list and cannot be a phone column","contact.columns.do.not.contain.email.column":"The contact columns do not contain email column","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.columns.limit.exceeded":"Number of email columns must not exceed the limit.","contact.columns.dont.match":"Contact columns field and ordered contact columns field must match.","column.data.type.specifications.summed.maxlength.exceeds.maximum.allowed":"The sum of maxlength for all column data type specifications text columns exceeds the maximum allowed.","invalid.column.data.type.specifications.max.values":"The numeric column data type specifications max value is invalid.","not.unique.phone.columns":"Phone Number Columns contain duplicate values.","invalid.property":"Value [%s] is not a valid property for object [%s]","no.email.columns":"No email columns provided","max.entity.count.reached":"The maximum contact list count has been reached.","phone.columns.limit.exceeded":"Number of phone columns must not exceed the limit.","column.data.type.specification.column.name.not.found":"Column data type specification column name is not a valid contact list column","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.columns.limit.exceeded":"Number of contact columns must not exceed the limit.","cannot.have.zip.code.column.without.automatic.time.zone.mapping":"The zip code column can only be used when automatic time zone mapping is also being used","invalid.contact.data.value":"The contact data values are invalid.","invalid.column.data.type.specifications.min.values":"The numeric column data type specifications min value is invalid.","contact.list.email.columns.not.supported":"Contact list email columns not supported.","missing.column.data.type.specification.max.length":"The numeric column data type specifications max length value is required."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:add"]},"x-purecloud-method-name":"postOutboundContactlists"},"delete":{"tags":["Outbound"],"summary":"Delete multiple contact lists.","description":"","operationId":"deleteOutboundContactlists","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"contact list id(s) to delete","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"Contact lists accepted for delete."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deletes":"There were too many contact lists in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bulk.delete.conflict":"Not all the requested contact lists could be deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:delete"]},"x-purecloud-method-name":"deleteOutboundContactlists"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}":{"get":{"tags":["Outbound"],"summary":"Get a contact.","description":"","operationId":"getOutboundContactlistContact","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:view"]},"x-purecloud-method-name":"getOutboundContactlistContact"},"put":{"tags":["Outbound"],"summary":"Update a contact.","description":"","operationId":"putOutboundContactlistContact","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact","required":true,"schema":{"$ref":"#/definitions/DialerContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.missing.columns":"The contact is missing columns from its contact list.","contact.list.clear.in.progress":"The contact list is currently being cleared.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","contact.does.not.exist":"The contact does not exist.","constraint.validation":"%s","invalid.update":"An attempt was made to update a contact in an invalid way","invalid.contact.id":"An attempt was made to update a contact with an invalid contact ID","contact.column.length.limit.exceeded":"The length of each contact column must not exceed the limit.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","contact.missing.data":"The data field is required.","contact.id.length.limit.exceeded":"The length of a contact id must not exceed the limit.","contact.columns.limit.exceeded":"Number of contact columns must not exceed the limit.","contact.datum.length.limit.exceeded":"The length of each piece of contact data must not exceed the limit.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:edit"]},"x-purecloud-method-name":"putOutboundContactlistContact"},"delete":{"tags":["Outbound"],"summary":"Delete a contact.","description":"","operationId":"deleteOutboundContactlistContact","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.in.use":"The contact cannot be deleted because it is currently in use.","invalid.delete":"An attempt was made to delete a contact in an invalid way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","contact.not.found":"The contact could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:delete"]},"x-purecloud-method-name":"deleteOutboundContactlistContact"}},"/api/v2/outbound/contactlists/{contactListId}/clear":{"post":{"tags":["Outbound"],"summary":"Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.","description":"","operationId":"postOutboundContactlistClear","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"}],"responses":{"204":{"description":"Contacts will be deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.is.on.running.campaign":"The contacts cannot be removed from a contactlist that is on a campaign that is in state ON or STOPPING.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","contact.list.import.in.progress":"The contacts cannot be removed from a contactlist that is currently in progress of an import.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:delete"]},"x-purecloud-method-name":"postOutboundContactlistClear"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.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/remove":{"post":{"tags":["Outbound"],"summary":"Start an async job to delete contacts using a filter.","description":"","operationId":"postOutboundContactlistContactsBulkRemove","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact filter information.","required":true,"schema":{"$ref":"#/definitions/ContactBulkSearchParameters"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactsBulkOperationJob"}},"202":{"description":"Contacts deletion has been started on the Contact List.","schema":{"$ref":"#/definitions/ContactsBulkOperationJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.clear.in.progress":"The contact list is currently being cleared.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","contact.bulk.operation.in.progress":"There is already a bulk operation in progress for this contact list.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.contact.list.filter":"The contact list filter provided is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:delete"]},"x-purecloud-method-name":"postOutboundContactlistContactsBulkRemove"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/bulk":{"post":{"tags":["Outbound"],"summary":"Get contacts from a contact list.","description":"","operationId":"postOutboundContactlistContactsBulk","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactIds to get.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/DialerContact"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.contacts.requested":"Only 50 contacts can be retrieved at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:view"]},"x-purecloud-method-name":"postOutboundContactlistContactsBulk"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/update":{"post":{"tags":["Outbound"],"summary":"Start an async job to bulk edit contacts.","description":"","operationId":"postOutboundContactlistContactsBulkUpdate","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact bulk edit request information.","required":true,"schema":{"$ref":"#/definitions/ContactBulkEditRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactsBulkOperationJob"}},"202":{"description":"Contacts edit has been started on the Contact List.","schema":{"$ref":"#/definitions/ContactsBulkOperationJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.clear.in.progress":"The contact list is currently being cleared.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","contact.bulk.operation.in.progress":"There is already a bulk operation in progress for this contact list.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.contact.list.filter":"The contact list filter provided is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:edit"]},"x-purecloud-method-name":"postOutboundContactlistContactsBulkUpdate"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/search":{"post":{"tags":["Outbound"],"summary":"Query contacts from a contact list.","description":"","operationId":"postOutboundContactlistContactsSearch","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact search parameters.","required":true,"schema":{"$ref":"#/definitions/ContactListingRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListingResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.contact.list.filter":"The contact list filter provided is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:view"]},"x-purecloud-method-name":"postOutboundContactlistContactsSearch"}},"/api/v2/outbound/contactlists/{contactListId}/contacts":{"post":{"tags":["Outbound"],"summary":"Add contacts to a contact list.","description":"","operationId":"postOutboundContactlistContacts","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WritableDialerContact"}}},{"name":"priority","in":"query","description":"Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue.","required":false,"type":"boolean"},{"name":"clearSystemData","in":"query","description":"Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won't.","required":false,"type":"boolean"},{"name":"doNotQueue","in":"query","description":"Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the 'priority' parameter.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/DialerContact"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.contacts.added":"Too many contacts added, the limit is 1000 per request","uploads.black.listed":"This organization has been prohibited from uploading contacts. Please contact support.","contact.missing.columns":"The contact is missing columns from its contact list.","invalid.contact.columns":"The contact columns are invalid.","contact.list.clear.in.progress":"The contact list is currently being cleared.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to create contacts in an invalid way","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.update":"An attempt was made to update contacts in an invalid way","invalid.contact.id":"The custom contactId field is not valid. It cannot contain special characters.","contact.column.length.limit.exceeded":"The length of each contact column must not exceed the limit.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","contact.missing.data":"The data field is required.","contact.id.length.limit.exceeded":"The length of a contact id must not exceed the limit.","contact.columns.limit.exceeded":"Number of contact columns must not exceed the limit.","contact.datum.length.limit.exceeded":"The length of each piece of contact data must not exceed the limit.","contacts.per.org.limit.exceeded":"The organization has reached the limit on total contacts","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal service error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:add"]},"x-purecloud-method-name":"postOutboundContactlistContacts"},"delete":{"tags":["Outbound"],"summary":"Delete contacts from a contact list.","description":"","operationId":"deleteOutboundContactlistContacts","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactIds","in":"query","description":"ContactIds to delete.","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"Contacts Deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.contacts.added":"There were too many contacts in the request, the limit is 250","invalid.contact.id":"One or more of the contacts was invalidly formed with non UTF-8 characters.","invalid.delete":"An attempt was made to delete contacts in an invalid way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","no.contacts.specified":"There were no contacts specified in the request."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:delete"]},"x-purecloud-method-name":"deleteOutboundContactlistContacts"}},"/api/v2/outbound/conversations/{conversationId}/dnc":{"post":{"tags":["Outbound"],"summary":"Add phone numbers to a Dialer DNC list.","description":"","operationId":"postOutboundConversationDnc","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:add"]},"x-purecloud-method-name":"postOutboundConversationDnc"}},"/api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns":{"delete":{"tags":["Outbound"],"summary":"Deletes all or expired custom exclusion column entries from a DNC list.","description":"This operation is only for Internal DNC lists of custom exclusion column entries","operationId":"deleteOutboundDnclistCustomexclusioncolumns","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"expiredOnly","in":"query","description":"Set to true to only remove DNC entries that are expired","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"DNC custom exclusion column entries deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.import.in.progress":"Custom exclusion column entries cannot be removed from a dnclist while it is being imported.","dnc.source.operation.not.supported":"An attempt was made to clear a DNC list that is not of type Internal custom","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dnc.list.invalid.contact.method":"An attempt was made to add to or delete from a DNC list that is not of Contact Method Any"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:delete"]},"x-purecloud-method-name":"deleteOutboundDnclistCustomexclusioncolumns"},"patch":{"tags":["Outbound"],"summary":"Add entries to or delete entries from a DNC list.","description":"Only Internal DNC lists may be deleted from","operationId":"patchOutboundDnclistCustomexclusioncolumns","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC Custom exclusion column entries","required":true,"schema":{"$ref":"#/definitions/DncPatchCustomExclusionColumnsRequest"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.source.operation.not.supported":"An attempt was made to add to or delete from a DNC list that is not of type Rds-custom","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.records.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","invalid.date.value":"The expiration date provided is invalid. It must be a UTC time in a format such as yyyy-MM-ddTHH:mmZ","constraint.validation":"%s","invalid.dnc.patch.request":"Custom exclusion column entries must be provided in the request","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.dnc.patch.action":"An action must be provided in the request","dnc.list.invalid.contact.method":"An attempt was made to add to or delete from a DNC list that is not of Contact Method Any","dnc.records.per.organization.limit.exceeded":"The organization has reached the limit on total DNC entries. See details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dnc.delete.entries.max.per.request.exceeded":"There were too many entries in the request, the limit is 250"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The DNC list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:edit"]},"x-purecloud-method-name":"patchOutboundDnclistCustomexclusioncolumns"}},"/api/v2/outbound/dnclists/divisionviews/{dncListId}":{"get":{"tags":["Outbound"],"summary":"Get a basic DncList information object","description":"This returns a simplified version of a DncList, consisting of the name, division, import status, and size.","operationId":"getOutboundDnclistsDivisionview","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"Dnclist ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncListDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dncList:search"]},"x-purecloud-method-name":"getOutboundDnclistsDivisionview"}},"/api/v2/outbound/dnclists/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of simplified dnc list objects.","description":"This return a simplified version of dnc lists, consisting of the name, division, import status, and size.","operationId":"getOutboundDnclistsDivisionviews","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"dncSourceType","in":"query","description":"DncSourceType","required":false,"type":"string","enum":["rds","rds_custom","dnc.com","gryphon"]},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncListDivisionViewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 dnc lists can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dncList:search"]},"x-purecloud-method-name":"getOutboundDnclistsDivisionviews"}},"/api/v2/outbound/dnclists/{dncListId}/emailaddresses":{"post":{"tags":["Outbound"],"summary":"Add email addresses to a DNC list.","description":"Only Internal DNC lists may be appended to","operationId":"postOutboundDnclistEmailaddresses","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC email addresses","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"Accepted - Adding email addresses"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.source.operation.not.supported":"An attempt was made to append emails to a DNC list that is not of type Internal","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.records.per.organization.limit.exceeded":"The organization has reached the limit on total DNC records. See details","dnc.records.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","invalid.date.value":"The date was invalid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The DNC list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:add"]},"x-purecloud-method-name":"postOutboundDnclistEmailaddresses"},"delete":{"tags":["Outbound"],"summary":"Deletes all or expired email addresses from a DNC list.","description":"This operation is Only for Internal DNC lists of email addresses","operationId":"deleteOutboundDnclistEmailaddresses","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"expiredOnly","in":"query","description":"Set to true to only remove DNC entries that are expired","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"DNC email addresses deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.import.in.progress":"The email addresses cannot be removed from a dnclist while it is being imported.","dnc.source.operation.not.supported":"An attempt was made to clear a DNC list that is not of type Internal","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dnc.list.invalid.contact.method":"An attempt was made to delete emails from a DNC list that is not of Contact Method Email"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"DNC list delete all or expired entries feature not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:delete"]},"x-purecloud-method-name":"deleteOutboundDnclistEmailaddresses"},"patch":{"tags":["Outbound"],"summary":"Add emails to or Delete emails from a DNC list.","description":"Only Internal DNC lists may be added to or deleted from","operationId":"patchOutboundDnclistEmailaddresses","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC Emails","required":true,"schema":{"$ref":"#/definitions/DncPatchEmailsRequest"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.source.operation.not.supported":"An attempt was made to add emails addresses to or delete email addresses from a DNC list that is not of type rds_custom\"","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.records.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","invalid.date.value":"The expiration date provided is invalid. It must be a UTC time in a format such as yyyy-MM-ddTHH:mmZ","constraint.validation":"%s","invalid.dnc.patch.request":"Email addresses must be provided in the request","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.dnc.patch.action":"An action must be provided in the request","dnc.list.invalid.contact.method":"An attempt was made to add emails to or delete emails from a DNC list that is not of Contact Method Email","dnc.records.per.organization.limit.exceeded":"The organization has reached the limit on total DNC records. See details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dnc.delete.entries.max.per.request.exceeded":"There were too many entries in the request, the limit is 250"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The DNC list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"DNC list delete all or expired entries feature not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:edit"]},"x-purecloud-method-name":"patchOutboundDnclistEmailaddresses"}},"/api/v2/outbound/dnclists/{dncListId}/export":{"get":{"tags":["Outbound"],"summary":"Get the URI of a DNC list export.","description":"","operationId":"getOutboundDnclistExport","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"download","in":"query","description":"Redirect to download uri","required":false,"type":"string","default":"false"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportUri"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","no.available.list.export.uri":"There is no available download URI for the dnc list at this time.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dnc:view","outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclistExport"},"post":{"tags":["Outbound"],"summary":"Initiate the export of a dnc list.","description":"Returns 200 if received OK.","operationId":"postOutboundDnclistExport","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityRef"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.import.in.progress":"The dnc list cannot be exported while it is being imported.","unexportable.dnc.list.type":"Only internal dnc lists can be exported.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.list.export.in.progress":"An export is already in progress for this dnc list.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The dnc list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dnc:view","outbound:dncList:view"]},"x-purecloud-method-name":"postOutboundDnclistExport"}},"/api/v2/outbound/dnclists/{dncListId}/importstatus":{"get":{"tags":["Outbound"],"summary":"Get dialer dncList import status.","description":"","operationId":"getOutboundDnclistImportstatus","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclistImportstatus"}},"/api/v2/outbound/dnclists/{dncListId}/phonenumbers":{"post":{"tags":["Outbound"],"summary":"Add phone numbers to a DNC list.","description":"Only Internal DNC lists may be appended to","operationId":"postOutboundDnclistPhonenumbers","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC Phone Numbers","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"expirationDateTime","in":"query","description":"Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format","required":false,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.source.operation.not.supported":"An attempt was made to append numbers to a DNC list that is not of type Internal","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.records.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","invalid.date.value":"The date was invalid.","constraint.validation":"%s","dnc.phone.numbers.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dnc.records.per.organization.limit.exceeded":"The organization has reached the limit on total DNC records. See details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dnc.phone.numbers.per.organization.limit.exceeded":"The organization has reached the limit on total DNC records. See details"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The DNC list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:add"]},"x-purecloud-method-name":"postOutboundDnclistPhonenumbers"},"delete":{"tags":["Outbound"],"summary":"Deletes all or expired phone numbers from a DNC list.","description":"This operation is Only for Internal DNC lists of phone numbers","operationId":"deleteOutboundDnclistPhonenumbers","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"expiredOnly","in":"query","description":"Set to true to only remove DNC entries that are expired","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"DNC phone numbers deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.import.in.progress":"The phone numbers cannot be removed from a dnclist while it is being imported.","dnc.source.operation.not.supported":"An attempt was made to clear a DNC list that is not of type Internal","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dnc.list.invalid.contact.method":"An attempt was made to delete numbers from a DNC list that is not of Contact Method Phone"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"DNC list delete all or expired entries feature not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:delete"]},"x-purecloud-method-name":"deleteOutboundDnclistPhonenumbers"},"patch":{"tags":["Outbound"],"summary":"Add numbers to or delete numbers from a DNC list.","description":"Only Internal DNC lists may be added to deleted from","operationId":"patchOutboundDnclistPhonenumbers","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC Phone Numbers","required":true,"schema":{"$ref":"#/definitions/DncPatchPhoneNumbersRequest"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.source.operation.not.supported":"An attempt was made to add numbers to or delete numbers from a DNC list that is not of type rds_custom","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.records.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","invalid.date.value":"The expiration date provided is invalid. It must be a UTC time in a format such as yyyy-MM-ddTHH:mmZ","constraint.validation":"%s","invalid.dnc.patch.request":"Phone numbers must be provided in the request","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.dnc.patch.action":"An action must be provided in the request","dnc.list.invalid.contact.method":"An attempt was made to add numbers to or delete numbers from a DNC list that is not of Contact Method Phone","dnc.records.per.organization.limit.exceeded":"The organization has reached the limit on total DNC records. See details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dnc.delete.entries.max.per.request.exceeded":"There were too many entries in the request, the limit is 250"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The DNC list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"DNC list delete all or expired entries feature not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:edit"]},"x-purecloud-method-name":"patchOutboundDnclistPhonenumbers"}},"/api/v2/outbound/dnclists/{dncListId}":{"get":{"tags":["Outbound"],"summary":"Get dialer DNC list","description":"","operationId":"getOutboundDnclist","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The dialer DNC list was not found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclist"},"put":{"tags":["Outbound"],"summary":"Update dialer DNC list","description":"","operationId":"putOutboundDnclist","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DncList","required":true,"schema":{"$ref":"#/definitions/DncList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","dnc.source.configuration.invalid.campaign.id":"The DNCScrub Campaign Id in dnc source configuration is invalid","invalid.property":"Value [%s] is not a valid property for object [%s]","cannot.update.dnc.list.type":"The Dnc source cannot be updated.","cannot.update.custom.exclusion.column":"The dnc custom exclusion column cannot be updated.","dnc.list.phone.columns.empty":"","dnc.records.per.list.limit.exceeded":"The dnc records per list exceeded the limit.","constraint.validation":"%s","invalid.update":"","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dnc.source.authentication.failed":"External dnc source was not able to authenticate.","dnc.source.region.not.supported":"The dnc source is not supported in the region","dnc.source.server.error":"External dnc source returned an error condition","dnc.records.per.organization.limit.exceeded":"The dnc records per organization exceeded the limit.","dnc.source.configuration.invalid":"The dnc source configuration is invalid","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:edit"]},"x-purecloud-method-name":"putOutboundDnclist"},"delete":{"tags":["Outbound"],"summary":"Delete dialer DNC list","description":"","operationId":"deleteOutboundDnclist","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.in.use":"The dialer DNC list is in use.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:delete"]},"x-purecloud-method-name":"deleteOutboundDnclist"}},"/api/v2/outbound/dnclists":{"get":{"tags":["Outbound"],"summary":"Query dialer DNC lists","description":"","operationId":"getOutboundDnclists","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"dncSourceType","in":"query","description":"DncSourceType","required":false,"type":"string","enum":["rds","rds_custom","dnc.com","gryphon"]},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncListEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclists"},"post":{"tags":["Outbound"],"summary":"Create dialer DNC list","description":"","operationId":"postOutboundDnclists","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DncList","required":true,"schema":{"$ref":"#/definitions/DncListCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","dnc.list.missing.custom.exclusion.column":"A custom exclusion column must be provided for this list type.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","dnc.source.configuration.invalid.campaign.id":"The DNCScrub Campaign Id in dnc source configuration is invalid","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.list.phone.columns.empty":"","dnc.records.per.list.limit.exceeded":"The dnc records per list exceeded the limit.","constraint.validation":"%s","max.entity.count.reached":"The maximum dnc list count has been reached.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dnc.source.authentication.failed":"External dnc source was not able to authenticate.","dnc.source.region.not.supported":"The dnc source is not supported in the region","dnc.source.server.error":"External dnc source returned an error condition","dnc.records.per.organization.limit.exceeded":"The dnc records per organization exceeded the limit.","dnc.source.configuration.invalid":"The dnc source configuration is invalid","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:add"]},"x-purecloud-method-name":"postOutboundDnclists"}},"/api/v2/outbound/events/{eventId}":{"get":{"tags":["Outbound"],"summary":"Get Dialer Event","description":"","operationId":"getOutboundEvent","produces":["application/json"],"parameters":[{"name":"eventId","in":"path","description":"Event Log ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventLog"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:eventLog:view"]},"x-purecloud-method-name":"getOutboundEvent"}},"/api/v2/outbound/events":{"get":{"tags":["Outbound"],"summary":"Query Event Logs","description":"","operationId":"getOutboundEvents","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"category","in":"query","description":"Category","required":false,"type":"string"},{"name":"level","in":"query","description":"Level","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerEventEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:eventLog:view"]},"x-purecloud-method-name":"getOutboundEvents"}},"/api/v2/outbound/filespecificationtemplates/bulk":{"delete":{"tags":["Outbound"],"summary":"Delete multiple file specification templates.","description":"","operationId":"deleteOutboundFilespecificationtemplatesBulk","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"File Specification template id(s) to delete","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"File specification templates accepted for delete."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deletes":"There were too many file specification templates in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bulk.delete.conflict":"Not all the requested file specification templates could be deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:fileSpecificationTemplate:delete"]},"x-purecloud-method-name":"deleteOutboundFilespecificationtemplatesBulk"}},"/api/v2/outbound/filespecificationtemplates":{"get":{"tags":["Outbound"],"summary":"Query File Specification Templates","description":"","operationId":"getOutboundFilespecificationtemplates","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FileSpecificationTemplateEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:fileSpecificationTemplate:view"]},"x-purecloud-method-name":"getOutboundFilespecificationtemplates"},"post":{"tags":["Outbound"],"summary":"Create File Specification Template","description":"","operationId":"postOutboundFilespecificationtemplates","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"FileSpecificationTemplate","required":true,"schema":{"$ref":"#/definitions/FileSpecificationTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FileSpecificationTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","column.length.out.of.bounds":"Column length is out of bounds","name.length.exceeded":"The name length exceeds the limit of 64 characters.","invalid.find.pattern":"\"find\" is not valid Java Regular Expression","bad.request":"The request could not be understood by the server due to malformed syntax.","skipped.lines.out.of.bounds":"Provided number of lines to be skipped is out of bounds","column.start.position.out.of.bounds":"Column startPosition is out of bounds","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","find.value.out.of.bounds":"\"find\" is out of bounds","replace.value.out.of.bounds":"\"replaceWith\" is out of bounds","missing.column.name":"Column name is required","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.column.information":"FixedLength format and Delimited format without header must have information about columns","invalid.delimiter.value":"When using Custom delimiter, the delimiterValue must be single character string","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.preprocessing.rules":"Too many pre-processing rules"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"duplicate.name":"The name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:fileSpecificationTemplate:add"]},"x-purecloud-method-name":"postOutboundFilespecificationtemplates"}},"/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}":{"get":{"tags":["Outbound"],"summary":"Get File Specification Template","description":"","operationId":"getOutboundFilespecificationtemplate","produces":["application/json"],"parameters":[{"name":"fileSpecificationTemplateId","in":"path","description":"File Specification Template ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FileSpecificationTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:fileSpecificationTemplate:view"]},"x-purecloud-method-name":"getOutboundFilespecificationtemplate"},"put":{"tags":["Outbound"],"summary":"Update File Specification Template","description":"","operationId":"putOutboundFilespecificationtemplate","produces":["application/json"],"parameters":[{"name":"fileSpecificationTemplateId","in":"path","description":"File Specification Template ID","required":true,"type":"string"},{"in":"body","name":"body","description":"fileSpecificationTemplate","required":true,"schema":{"$ref":"#/definitions/FileSpecificationTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FileSpecificationTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","column.length.out.of.bounds":"Column length is out of bounds","name.length.exceeded":"The name length exceeds the limit of 64 characters.","invalid.find.pattern":"\"find\" is not valid Java Regular Expression","bad.request":"The request could not be understood by the server due to malformed syntax.","skipped.lines.out.of.bounds":"Provided number of lines to be skipped is out of bounds","column.start.position.out.of.bounds":"Column startPosition is out of bounds","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","find.value.out.of.bounds":"\"find\" is out of bounds","replace.value.out.of.bounds":"\"replaceWith\" is out of bounds","missing.column.name":"Column name is required","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.column.information":"FixedLength format and Delimited format without header must have information about columns","invalid.delimiter.value":"When using Custom delimiter, the delimiterValue must be single character string","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.preprocessing.rules":"Too many pre-processing rules"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"duplicate.name":"The name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:fileSpecificationTemplate:edit"]},"x-purecloud-method-name":"putOutboundFilespecificationtemplate"},"delete":{"tags":["Outbound"],"summary":"Delete File Specification Template","description":"","operationId":"deleteOutboundFilespecificationtemplate","produces":["application/json"],"parameters":[{"name":"fileSpecificationTemplateId","in":"path","description":"File Specification Template ID","required":true,"type":"string"}],"responses":{"204":{"description":"File Specification template deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:fileSpecificationTemplate:delete"]},"x-purecloud-method-name":"deleteOutboundFilespecificationtemplate"}},"/api/v2/outbound/importtemplates/{importTemplateId}/importstatus":{"get":{"tags":["Outbound"],"summary":"Get the import status for an import template.","description":"","operationId":"getOutboundImporttemplateImportstatus","produces":["application/json"],"parameters":[{"name":"importTemplateId","in":"path","description":"importTemplateId","required":true,"type":"string"},{"name":"listNamePrefix","in":"query","description":"listNamePrefix","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:view"]},"x-purecloud-method-name":"getOutboundImporttemplateImportstatus"}},"/api/v2/outbound/importtemplates/{importTemplateId}":{"get":{"tags":["Outbound"],"summary":"Get Import Template","description":"","operationId":"getOutboundImporttemplate","produces":["application/json"],"parameters":[{"name":"importTemplateId","in":"path","description":"Import Template ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:view"]},"x-purecloud-method-name":"getOutboundImporttemplate"},"put":{"tags":["Outbound"],"summary":"Update Import Template","description":"","operationId":"putOutboundImporttemplate","produces":["application/json"],"parameters":[{"name":"importTemplateId","in":"path","description":"Import Template ID","required":true,"type":"string"},{"in":"body","name":"body","description":"importTemplate","required":true,"schema":{"$ref":"#/definitions/ImportTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","contact.list.template.not.found":"Could not update the import template because the contact list template could not be found.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","criteria.value.cannot.be.blank":"Criteria value must be provided.","constraint.validation":"%s","invalid.contact.list.filter":"Could not update the import template because the contact list filter is not valid.","invalid.criteria.value":"Could not update the import template because the criteria value is invalid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","contact.list.template.required":"A contact list template id must be provided.","spllitting.information.cannot.be.blank":"The splitting information must be provided when useSplittingCriteria is true.","criteria.value.is.out.of.bounds":"Criteria value is out of bounds.","invalid.list.name.format":"List name format is not valid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"Could not update the import template because the contact list filter could not be found."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"duplicate.name":"The name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:edit"]},"x-purecloud-method-name":"putOutboundImporttemplate"},"delete":{"tags":["Outbound"],"summary":"Delete Import Template","description":"","operationId":"deleteOutboundImporttemplate","produces":["application/json"],"parameters":[{"name":"importTemplateId","in":"path","description":"Import Template ID","required":true,"type":"string"}],"responses":{"204":{"description":"Import template deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","import.template.in.use":"The import template is in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:delete"]},"x-purecloud-method-name":"deleteOutboundImporttemplate"}},"/api/v2/outbound/importtemplates":{"get":{"tags":["Outbound"],"summary":"Query Import Templates","description":"","operationId":"getOutboundImporttemplates","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]},{"name":"contactListTemplateId","in":"query","description":"Contact List Template ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportTemplateEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:view"]},"x-purecloud-method-name":"getOutboundImporttemplates"},"post":{"tags":["Outbound"],"summary":"Create Import Template","description":"","operationId":"postOutboundImporttemplates","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ImportTemplate","required":true,"schema":{"$ref":"#/definitions/ImportTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","contact.list.template.not.found":"Could not update the import template because the contact list template could not be found.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","criteria.value.cannot.be.blank":"Criteria value must be provided.","constraint.validation":"%s","invalid.contact.list.filter":"Could not update the import template because the contact list filter is not valid.","max.entity.count.reached":"The maximum import template count has been reached.","invalid.criteria.value":"Could not update the import template because the criteria value is invalid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","contact.list.template.required":"A contact list template id must be provided.","spllitting.information.cannot.be.blank":"The splitting information must be provided when useSplittingCriteria is true.","criteria.value.is.out.of.bounds":"Criteria value is out of bounds.","invalid.list.name.format":"List name format is not valid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"Could not update the import template because the contact list filter could not be found."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"duplicate.name":"The name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:add"]},"x-purecloud-method-name":"postOutboundImporttemplates"},"delete":{"tags":["Outbound"],"summary":"Delete multiple import templates.","description":"","operationId":"deleteOutboundImporttemplates","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"import template id(s) to delete","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"Import templates accepted for delete."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deletes":"There were too many import templates in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bulk.delete.import.template":"Not all the requested import templates could be deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:delete"]},"x-purecloud-method-name":"deleteOutboundImporttemplates"}},"/api/v2/outbound/importtemplates/bulk/add":{"post":{"tags":["Outbound"],"summary":"Add multiple import templates","description":"","operationId":"postOutboundImporttemplatesBulkAdd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"import template(s) to add","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ImportTemplate"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportTemplateEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.import.templates.added":"The number of import templates being added exceeds the limit","bad.request":"No import templates were provided in request.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:add"]},"x-purecloud-method-name":"postOutboundImporttemplatesBulkAdd"}},"/api/v2/outbound/messagingcampaigns/progress":{"post":{"tags":["Outbound"],"summary":"Get progress for a list of messaging campaigns","description":"","operationId":"postOutboundMessagingcampaignsProgress","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Messaging Campaign IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignProgress"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.missing.callback.numbers":"Callback numbers missing","callback.error.missing.queue.id":"Callback missing queue ID","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view","outbound:emailCampaign:view"]},"x-purecloud-method-name":"postOutboundMessagingcampaignsProgress"}},"/api/v2/outbound/settings":{"get":{"tags":["Outbound"],"summary":"Get the outbound settings for this organization","description":"","operationId":"getOutboundSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:settings:view"]},"x-purecloud-method-name":"getOutboundSettings"},"patch":{"tags":["Outbound"],"summary":"Update the outbound settings for this organization","description":"","operationId":"patchOutboundSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"outboundSettings","required":true,"schema":{"$ref":"#/definitions/OutboundSettings"}}],"responses":{"204":{"description":"Accepted - Processing Update"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.callable.window.stop.time":"Latest callable time must not be later than 21:00","invalid.country.code":"Invalid country country provided for atzm supportedCountries","invalid.callable.window":"Earliest callable time must be before Latest callable time and only one callable time window is allowed","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.max.calls.per.agent":"Max calls per agent must be between values 1 and 15.","missing.time.zone":"Time zone must be provided for unmapped call window","invalid.time.zone":"Invalid time zone for unmapped call window","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.abandon.seconds":"Abandon seconds must be between 1 and 300.","constraint.validation":"%s","invalid.callable.window.start.time":"Earliest callable time must not be earlier than 08:00","invalid.update":"An attempt was made to update the outbound settings in an invalid way","invalid.max.line.utilization":"Max outbound line utilization must be between .01 and 1 and can only have 2 digits after the decimal.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":"outbound settings version does not match expected"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:settings:edit"]},"x-purecloud-method-name":"patchOutboundSettings"}},"/api/v2/outbound/rulesets/{ruleSetId}":{"get":{"tags":["Outbound"],"summary":"Get a Rule Set by ID.","description":"","operationId":"getOutboundRuleset","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:view"]},"x-purecloud-method-name":"getOutboundRuleset"},"put":{"tags":["Outbound"],"summary":"Update a Rule Set.","description":"","operationId":"putOutboundRuleset","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"RuleSet","required":true,"schema":{"$ref":"#/definitions/RuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.rule.action":"","name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.rule.condition":"","invalid.property":"Value [%s] is not a valid property for object [%s]","data.action.not.found":"The requested data action could not be found","constraint.validation":"%s","invalid.update":"","rule.conflict":"Duplicated Rule IDs and/or names.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.rule.condition.category":"The condition is not valid for the given category.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.rule.action.category":"The action is not valid for the given category."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:edit"]},"x-purecloud-method-name":"putOutboundRuleset"},"delete":{"tags":["Outbound"],"summary":"Delete a Rule Set.","description":"","operationId":"deleteOutboundRuleset","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:delete"]},"x-purecloud-method-name":"deleteOutboundRuleset"}},"/api/v2/outbound/rulesets":{"get":{"tags":["Outbound"],"summary":"Query a list of Rule Sets.","description":"","operationId":"getOutboundRulesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:view"]},"x-purecloud-method-name":"getOutboundRulesets"},"post":{"tags":["Outbound"],"summary":"Create a Rule Set.","description":"","operationId":"postOutboundRulesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"RuleSet","required":true,"schema":{"$ref":"#/definitions/RuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.rule.action":"","name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","invalid.rule.condition":"","invalid.property":"Value [%s] is not a valid property for object [%s]","data.action.not.found":"The requested data action could not be found","constraint.validation":"%s","max.entity.count.reached":"The maximum rule set count has been reached.","rule.conflict":"Duplicated Rule IDs and/or names.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.rule.condition.category":"The condition is not valid for the given category.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.rule.action.category":"The action is not valid for the given category."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:add"]},"x-purecloud-method-name":"postOutboundRulesets"}},"/api/v2/outbound/sequences/{sequenceId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer campaign sequence.","description":"","operationId":"getOutboundSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:view"]},"x-purecloud-method-name":"getOutboundSequence"},"put":{"tags":["Outbound"],"summary":"Update a new campaign sequence.","description":"","operationId":"putOutboundSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization","required":true,"schema":{"$ref":"#/definitions/CampaignSequence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","campaign.sequence.cannot.change.both.status.and.campaigns":"","name.length.exceeded":"The name length exceeds the limit of 64 characters.","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.","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":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:edit"]},"x-purecloud-method-name":"putOutboundSequence"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer campaign sequence.","description":"","operationId":"deleteOutboundSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.in.use":"The campaign sequence is already in use.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:delete"]},"x-purecloud-method-name":"deleteOutboundSequence"}},"/api/v2/outbound/schedules/sequences/{sequenceId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer sequence schedule.","description":"","operationId":"getOutboundSchedulesSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SequenceSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.not.found":"The campaign sequence was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesSequence"},"put":{"tags":["Outbound"],"summary":"Update a new sequence schedule.","description":"","operationId":"putOutboundSchedulesSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SequenceSchedule","required":true,"schema":{"$ref":"#/definitions/SequenceSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SequenceSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"","invalid.interval.time":"","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","future.intervals.exceeded.limit":""}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.not.found":"The campaign sequence was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":"The sequence schedule version does not match expected"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:edit"]},"x-purecloud-method-name":"putOutboundSchedulesSequence"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer sequence schedule.","description":"","operationId":"deleteOutboundSchedulesSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.not.found":"The campaign sequence was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:delete"]},"x-purecloud-method-name":"deleteOutboundSchedulesSequence"}},"/api/v2/outbound/schedules/sequences":{"get":{"tags":["Outbound"],"summary":"Query for a list of dialer sequence schedules.","description":"","operationId":"getOutboundSchedulesSequences","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/SequenceSchedule"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.interval.time":"","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesSequences"}},"/api/v2/outbound/sequences":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer campaign sequences.","description":"","operationId":"getOutboundSequences","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:view"]},"x-purecloud-method-name":"getOutboundSequences"},"post":{"tags":["Outbound"],"summary":"Create a new campaign sequence.","description":"","operationId":"postOutboundSequences","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization","required":true,"schema":{"$ref":"#/definitions/CampaignSequence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"A campaign sequence with this name already exists.","invalid.create":"","campaign.sequence.missing.campaign":"The dialer campaign sequence is missing a campaign.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","max.entity.count.reached":"The maximum campaign sequence count has been reached.","campaign.sequence.invalid.campaign":"At least one campaign is invalid","campaign.sequence.invalid.current.campaign":"Current campaign is invalid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","campaign.sequence.is.empty":"The dialer campaign sequence is empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:add"]},"x-purecloud-method-name":"postOutboundSequences"}},"/api/v2/outbound/wrapupcodemappings":{"get":{"tags":["Outbound"],"summary":"Get the Dialer wrap up code mapping.","description":"","operationId":"getOutboundWrapupcodemappings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapUpCodeMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:wrapUpCodeMapping:view"]},"x-purecloud-method-name":"getOutboundWrapupcodemappings"},"put":{"tags":["Outbound"],"summary":"Update the Dialer wrap up code mapping.","description":"","operationId":"putOutboundWrapupcodemappings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"wrapUpCodeMapping","required":true,"schema":{"$ref":"#/definitions/WrapUpCodeMapping"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapUpCodeMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"An attempt was made to update a wrap up code mapping in an invalid way","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":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":"Wrap up code mapping version does not match expected"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:wrapUpCodeMapping:edit"]},"x-purecloud-method-name":"putOutboundWrapupcodemappings"}},"/api/v2/outbound/digitalrulesets/{digitalRuleSetId}":{"get":{"tags":["Outbound"],"summary":"Get an Outbound Digital Rule Set","description":"","operationId":"getOutboundDigitalruleset","produces":["application/json"],"parameters":[{"name":"digitalRuleSetId","in":"path","description":"The Digital Rule Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DigitalRuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:digitalRuleSet:view"]},"x-purecloud-method-name":"getOutboundDigitalruleset"},"put":{"tags":["Outbound"],"summary":"Update an Outbound Digital Rule Set","description":"","operationId":"putOutboundDigitalruleset","produces":["application/json"],"parameters":[{"name":"digitalRuleSetId","in":"path","description":"The Digital Rule Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Digital Rule Set","required":true,"schema":{"$ref":"#/definitions/DigitalRuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DigitalRuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.rule.action":"One or more rule actions are invalid","name.length.exceeded":"The name length exceeds the limit of 64 characters","missing.rule.actions":"Each rule must have at least one action configured","too.many.rule.actions":"The number of actions in one or more rules exceeds the limit. See details","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name is in use by another digital rule set","invalid.rule.condition":"One or more rule conditions are invalid","invalid.rule.category":"A category must be provided for each rule","rule.name.length.exceeded":"The name length of a rule exceeds the limit of 64 characters","invalid.rule.name":"A name must be provided for each rule","constraint.validation":"%s","invalid.update":"An attempt was made to update a digital rule set in an invalid way. See details","invalid.name":"A name must be provided","too.many.rule.conditions":"The number of conditions in one or more rules exceeds the limit. See details","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","too.many.set.sms.phone.number.actions":"The limit for the number of set sms phone number actions per rule set has been exceeded. See details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","too.many.of.action":"One or more actions exceed the limit for that action. See details","too.many.data.action.conditions.per.ruleset":"The limit for the number of data action conditions per rule set has been exceeded. See details","invalid.rule.order":"An order must be provided for each rule","missing.rule.conditions":"At least one condition must be configured on each rule","rule.set.invalid.contact.list":"The contactListId must be a valid UUID representing a contact list","too.many.rules":"The number of rules exceeds the limit. See details","rule.conflict":"A unique id and unique name must be provided for each rule","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.rule.condition.category":"One or more rule conditions are invalid for the rule's category","invalid.rule.action.category":"One or more rule actions are invalid for the rule's category"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.conflict":"Unexpected digital rule set version"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:digitalRuleSet:edit"]},"x-purecloud-method-name":"putOutboundDigitalruleset"},"delete":{"tags":["Outbound"],"summary":"Delete an Outbound Digital Rule Set","description":"","operationId":"deleteOutboundDigitalruleset","produces":["application/json"],"parameters":[{"name":"digitalRuleSetId","in":"path","description":"The Digital Rule Set ID","required":true,"type":"string"}],"responses":{"204":{"description":"Digital Rule Set Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.delete":"An attempt was made to delete a digital rule set in an invalid way. See details","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:digitalRuleSet:delete"]},"x-purecloud-method-name":"deleteOutboundDigitalruleset"}},"/api/v2/outbound/digitalrulesets":{"get":{"tags":["Outbound"],"summary":"Query a list of Outbound Digital Rule Sets","description":"","operationId":"getOutboundDigitalrulesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"The field to sort by","required":false,"type":"string","default":"name","enum":["name"]},{"name":"sortOrder","in":"query","description":"The direction to sort","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"A list of digital rule set ids to bulk fetch","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DigitalRuleSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:digitalRuleSet:view"]},"x-purecloud-method-name":"getOutboundDigitalrulesets"},"post":{"tags":["Outbound"],"summary":"Create an Outbound Digital Rule Set","description":"","operationId":"postOutboundDigitalrulesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Digital Rule Set","required":true,"schema":{"$ref":"#/definitions/DigitalRuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DigitalRuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.rule.action":"One or more rule actions are invalid","name.length.exceeded":"The name length exceeds the limit of 64 characters","missing.rule.actions":"Each rule must have at least one action configured","too.many.rule.actions":"The number of actions in one or more rules exceeds the limit. See details","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to update a digital rule set in an invalid way. See details","duplicate.name":"The name is in use by another digital rule set","invalid.rule.condition":"One or more rule conditions are invalid","invalid.rule.category":"A category must be provided for each rule","rule.name.length.exceeded":"The name length of a rule exceeds the limit of 64 characters","invalid.rule.name":"A name must be provided for each rule","constraint.validation":"%s","invalid.name":"A name must be provided","too.many.rule.conditions":"The number of conditions in one or more rules exceeds the limit. See details","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","too.many.set.sms.phone.number.actions":"The limit for the number of set sms phone number actions per rule set has been exceeded. See details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","too.many.of.action":"One or more actions exceed the limit for that action. See details","too.many.data.action.conditions.per.ruleset":"The limit for the number of data action conditions per rule set has been exceeded. See details","invalid.rule.order":"An order must be provided for each rule","missing.rule.conditions":"At least one condition must be configured on each rule","rule.set.invalid.contact.list":"The contactListId must be a valid UUID representing a contact list","too.many.rules":"The number of rules exceeds the limit. See details","rule.conflict":"A unique id and unique name must be provided for each rule","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.rule.condition.category":"One or more rule conditions are invalid for the rule's category","invalid.rule.action.category":"One or more rule actions are invalid for the rule's category"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:digitalRuleSet:add"]},"x-purecloud-method-name":"postOutboundDigitalrulesets"}},"/api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId}":{"get":{"tags":["Outbound"],"summary":"Get a basic Messaging Campaign information object","description":"This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.","operationId":"getOutboundMessagingcampaignsDivisionview","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:search","outbound:emailCampaign:search"]},"x-purecloud-method-name":"getOutboundMessagingcampaignsDivisionview"}},"/api/v2/outbound/messagingcampaigns/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of basic Messaging Campaign information objects","description":"This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division.","operationId":"getOutboundMessagingcampaignsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"The direction to sort","required":false,"type":"string","default":"a","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"type","in":"query","description":"Campaign Type","required":false,"type":"string","enum":["EMAIL","SMS"]},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"senderSmsPhoneNumber","in":"query","description":"Sender SMS Phone Number","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:search","outbound:emailCampaign:search"]},"x-purecloud-method-name":"getOutboundMessagingcampaignsDivisionviews"}},"/api/v2/outbound/messagingcampaigns/{messagingCampaignId}":{"get":{"tags":["Outbound"],"summary":"Get an Outbound Messaging Campaign","description":"","operationId":"getOutboundMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The resource could not be found.","resource.not.found":"Specified campaignId was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view","outbound:emailCampaign:view"]},"x-purecloud-method-name":"getOutboundMessagingcampaign"},"put":{"tags":["Outbound"],"summary":"Update an Outbound Messaging Campaign","description":"","operationId":"putOutboundMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"MessagingCampaign","required":true,"schema":{"$ref":"#/definitions/MessagingCampaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.email.columns.in.contactlist":"The contact list must have at least one email column configured when the campaign is configured for email","column.data.type.specification.not.found.for.contact.sort":"A column data type specification must be defined for contact sort column","name.length.exceeded":"The name length exceeds the limit of 64 characters","active.campaigns.with.data.action.conditions.limit.exceeded":"The limit for the maximum number of active messaging campaigns using a data action condition has been exceeded. See details","invalid.column.data.type.specification.data.type":"Column data type specification data type must match the contact sort column data type","duplicate.name":"The name is in use by another messaging campaign","email.reply.to.address.domain.not.found":"The reply-to address domain could not be found","invalid.email.reply.to.address.route.domain":"The reply-to address route must have a reply route domain configured","contact.list.not.found":"The contact list could not be found","email.reply.to.address.domain.not.verified":"The reply-to address domain must have a verification result of 'VERIFIED'","missing.column.data.type.specification.in.contact.list":"Column data type specifications must be defined on the campaign's contact list","invalid.email.reply.to.address.domain":"The reply-to address domain must be provided, and must be a verified inbound domain registered with Genesys Cloud","too.many.messages.per.minute.with.data.actions.requested":"The total number of messages per minute for this organization and campaign with data actions would be exceeded by turning this campaign on (see documentation)","invalid.sender.sms.phone.number":"The sender sms phone number must be provided, and must be a valid reference to a short-code or non-NANP mobile or local SMS phone number","email.reply.to.address.route.not.inbound":"The reply-to address route must have one of queueId or workflowId configured","invalid.update":"An attempt was made to update a messaging campaign in an invalid way. See details","cannot.update.campaign.type":"The campaign type cannot be updated to a different type configuration","invalid.name":"A name must be provided","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","missing.email.content.template.subject":"The content template must contain exactly one response text of type subject","too.many.set.sms.phone.number.actions":"The limit for the number of set sms phone number actions has been exceeded. See details","cannot.update.dynamic.contact.queueing.settings":"Dynamic queueing cannot be changed once it's set","invalid.contact.list":"A valid contact list must be provided","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"The contact list filter could not be found","dnc.list.not.found":"One or more dnc lists could not be found","invalid.rule.set":"One or more rule set references are invalid","invalid.message.column":"The message column must be provided, and must be a valid column on the selected contact list","invalid.sms.config.message":"Only one of the messaging options should be set - messageColumn or contentTemplateId","email.from.address.domain.not.found":"The from address domain could not be found","simultaneous.field.and.status.update":"A Messaging Campaign cannot have other fields changed in the same update as a status transition","invalid.status.transition":"The campaign status transition is invalid","too.many.data.action.conditions.per.campaign":"The limit for the number of data action conditions per campaign has been exceeded. See details","rule.set.not.found":"One or more rule sets could not be found","invalid.email.content.template.body.content.type":"The content type of the content template body must be 'text/plain' or 'text/html","invalid.dnc.list":"One or more DNC List references are invalid","invalid.division":"A valid division must be provided","sms.phone.number.not.found":"The SMS phone number could not be found","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.content.template.not.authorized":"The user does not have authorization to access the content template","invalid.dnc.list.contact.method":"One or more dnc lists have an invalid contact method. All lists must have the appropriate contact method for the campaign type. See details","contact.list.in.use":"The contact list is in use by another messaging campaign","invalid.sms.content.template.content":"The content of the content template is blank","invalid.email.content.template.body.content":"The content of the content template body must not be blank","missing.contact.list.filter":"A contact list filter must be provided when dynamic filtering is enabled.","rule.set.count.exceeded":"The limit for the number of rule sets has been exceeded. See details","email.reply.to.address.route.not.found":"The reply-to address route could not be found","sms.content.template.mms.not.supported":"The Content template with mms is not supported for the sms phone number","bad.request":"The request could not be understood by the server due to malformed syntax.","callable.time.set.not.found":"The callable time set could not be found","invalid.callable.time.set":"The provided callable time set is invalid","callable.time.set.not.allowed.for.email":"A callable time set cannot be included on the campaign when it is configured for email","invalid.messages.per.minute":"Messages per minute must be provided, and must be an integer between 1 and the maximum allowable messages per minute for this campaign type (see documentation)","invalid.email.from.address.friendly.name":"The from address friendly name must be a between 1 and 64 characters long","constraint.validation":"%s","invalid.email.reply.to.address.route.pattern":"The reply-to address route must have a pattern configured","too.many.messages.per.minute.per.phone.number.requested":"The total number of messages per minute for this organization and phone number would be exceeded by turning this campaign on (see documentation)","dnc.list.invalid.custom.exclusion.column":"The Custom Exclusion Column on one of the chosen DNC lists does not match any of the columns on the chosen Contact List","invalid.phone.column":"The phone column must be provided, and must be a valid column on the selected contact list","invalid.email.content.template.texts":"The content template must contain exactly two response texts","missing.email.content.template.body":"The content template must contain exactly one response text of type body","invalid.email.from.address":"The from address must be provided","dynamic.queueing.campaigns.count.exceeded":"The limit for dynamic queueing campaigns has been exceeded","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","sms.content.template.not.found":"The Content template could not be found","contact.list.filter.mismatch":"The contact list on the contact list filter does not match the one on the campaign","invalid.email.reply.to.address.route":"The reply-to address route must be provided, and must be a route configured on the reply-to address domain","invalid.email.content.template.subject.content.type":"The content type of the content template subject must be 'text/plain'","another.campaign.starting":"There is another campaign already in the process of transitioning to on. Once it has transitioned fully then you will be allowed to turn another campaign on","contact.sort.duplicate.field.names":"Multiple Contact Sorts may not be applied to the same field","missing.phone.columns.in.contactlist":"The contact list must have at least one phone number column configured when the campaign is configured for SMS","contact.sort.size.exceeded":"A maximum of 4 Contact Sorts may be configured","invalid.sms.content.template.responsetype":"The response type of the content template must be 'CampaignSmsTemplate'","contact.sort.field.not.found":"One or more contact sort fields are not valid contact list columns","invalid.email.content.template.response.type":"The responseType of the content template must be 'CampaignEmailTemplate'","invalid.email.columns":"The email columns must be provided, and all entries must be valid columns on the contact list","dnc.list.count.exceeded":"A maximum of 10 dnc lists may be configured","invalid.sms.content.template.contentType":"The content type of the content template must be 'text/plain'","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.email.content.template.subject.content":"The content of the content template subject must not be blank","email.content.template.not.found":"The content template could not be found","sms.phone.number.in.use":"The SMS phone number is in use by another messaging campaign","dynamic.queueing.active.campaigns.count.exceeded":"The limit for active dynamic queueing campaigns has been exceeded","too.many.email.columns":"The limit for number of email columns has been exceeded. See details","too.many.contact.list.filters":"Only one contact list filter is allowed per campaign","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping","invalid.email.from.address.local.part":"The from address local part must be provided, and must be between 1 and 64 characters long","too.many.messages.per.minute.requested":"The total number of messages per minute for this organization and campaign type would be exceeded by turning this campaign on (see documentation)","sms.content.template.mms.phone.number.type.not.supported":"The Content template with mms is not supported for the sms phone number type","sms.content.template.not.authorized":"User doesn't have authorization to access content template","active.campaigns.limit.exceeded":"The maximum number of active campaigns has been reached. Please turn off at least one campaign and wait for it to stop before starting another one.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined","invalid.email.from.address.domain":"The from address domain must be provided, and must be a verified outbound domain registered with Genesys Cloud","contact.list.import.in.progress":"The contact list is still importing contacts","invalid.type.config":"Exactly one of [emailConfig, smsConfig] must be provided"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The messaging campaign could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.conflict":"Unexpected messaging campaign version"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:edit","outbound:emailCampaign:edit"]},"x-purecloud-method-name":"putOutboundMessagingcampaign"},"delete":{"tags":["Outbound"],"summary":"Delete an Outbound Messaging Campaign","description":"","operationId":"deleteOutboundMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"204":{"description":"Messaging Campaign Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.delete":"An attempt was made to delete a messaging campaign in an invalid way. See details","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","cannot.delete.running.campaign":"A messaging campaign in status ON or STOPPING cannot be deleted"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:delete","outbound:emailCampaign:delete"]},"x-purecloud-method-name":"deleteOutboundMessagingcampaign"}},"/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress":{"get":{"tags":["Outbound"],"summary":"Get messaging campaign's progress","description":"","operationId":"getOutboundMessagingcampaignProgress","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignProgress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The messaging campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view","outbound:emailCampaign:view"]},"x-purecloud-method-name":"getOutboundMessagingcampaignProgress"},"delete":{"tags":["Outbound"],"summary":"Reset messaging campaign progress and recycle the messaging campaign","description":"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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view","outbound:emailCampaign:view"]},"x-purecloud-method-name":"getOutboundMessagingcampaignDiagnostics"}},"/api/v2/outbound/messagingcampaigns":{"get":{"tags":["Outbound"],"summary":"Query a list of Messaging Campaigns","description":"","operationId":"getOutboundMessagingcampaigns","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"The field to sort by","required":false,"type":"string","default":"name","enum":["campaignStatus","name","type"]},{"name":"sortOrder","in":"query","description":"The direction to sort","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"contactListId","in":"query","description":"Contact List ID","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"type","in":"query","description":"Campaign Type","required":false,"type":"string","enum":["EMAIL","SMS"]},{"name":"senderSmsPhoneNumber","in":"query","description":"Sender SMS Phone Number","required":false,"type":"string"},{"name":"id","in":"query","description":"A list of messaging campaign ids to bulk fetch","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view","outbound:emailCampaign:view"]},"x-purecloud-method-name":"getOutboundMessagingcampaigns"},"post":{"tags":["Outbound"],"summary":"Create a Messaging Campaign","description":"","operationId":"postOutboundMessagingcampaigns","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Messaging Campaign","required":true,"schema":{"$ref":"#/definitions/MessagingCampaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.email.columns.in.contactlist":"The contact list must have at least one email column configured when the campaign is configured for email","column.data.type.specification.not.found.for.contact.sort":"A column data type specification must be defined for contact sort column","name.length.exceeded":"The name length exceeds the limit of 64 characters","active.campaigns.with.data.action.conditions.limit.exceeded":"The limit for the maximum number of active messaging campaigns using a data action condition has been exceeded. See details","invalid.column.data.type.specification.data.type":"Column data type specification data type must match the contact sort column data type","duplicate.name":"The name is in use by another messaging campaign","email.reply.to.address.domain.not.found":"The reply-to address domain could not be found","invalid.email.reply.to.address.route.domain":"The reply-to address route must have a reply route domain configured","contact.list.not.found":"The contact list could not be found","email.reply.to.address.domain.not.verified":"The reply-to address domain must have a verification result of 'VERIFIED'","missing.column.data.type.specification.in.contact.list":"Column data type specifications must be defined on the campaign's contact list","invalid.email.reply.to.address.domain":"The reply-to address domain must be provided, and must be a verified inbound domain registered with Genesys Cloud","invalid.sender.sms.phone.number":"The sender sms phone number must be provided, and must be a valid reference to a short-code or non-NANP mobile or local SMS phone number","email.reply.to.address.route.not.inbound":"The reply-to address route must have one of queueId or workflowId configured","invalid.name":"A name must be provided","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.sms.content.template.contenttype":"The content type of the content template must be 'text/plain'","missing.email.content.template.subject":"The content template must contain exactly one response text of type subject","invalid.contact.list":"A valid contact list must be provided","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"The contact list filter could not be found","dnc.list.not.found":"One or more dnc lists could not be found","invalid.rule.set":"One or more rule set references are invalid","invalid.message.column":"The message column must be provided, and must be a valid column on the selected contact list","invalid.sms.config.message":"Only one of the messaging options should be set - messageColumn or contentTemplateId","email.from.address.domain.not.found":"The from address domain could not be found","too.many.data.action.conditions.per.campaign":"The limit for the number of data action conditions per campaign has been exceeded. See details","rule.set.not.found":"One or more rule sets could not be found","invalid.email.content.template.body.content.type":"The content type of the content template body must be 'text/plain' or 'text/html'","invalid.dnc.list":"One or more DNC List references are invalid","max.entity.count.reached":"The maximum messaging campaign count has been reached","invalid.division":"A valid division must be provided","email.from.address.domain.not.verified":"The from address domain must have a cname verification result of 'VERIFIED'","sms.phone.number.not.found":"The SMS phone number could not be found","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.content.template.not.authorized":"The user does not have authorization to access the content template","invalid.dnc.list.contact.method":"One or more dnc lists have an invalid contact method. All lists must have the appropriate contact method for the campaign type. See details","invalid.sms.content.template.content":"The content of the content template is blank","invalid.email.content.template.body.content":"The content of the content template body must not be blank","rule.set.count.exceeded":"The limit for the number of rule sets has been exceeded. See details","email.reply.to.address.route.not.found":"The reply-to address route could not be found","sms.content.template.mms.not.supported":"The Content template with mms is not supported for the sms phone number","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to create an invalid messaging campaign. See details","callable.time.set.not.found":"The callable time set could not be found","invalid.callable.time.set":"The provided callable time set is invalid","callable.time.set.not.allowed.for.email":"A callable time set cannot be included on the campaign when it is configured for email","invalid.messages.per.minute":"Messages per minute must be provided, and must be an integer between 1 and the maximum allowable messages per minute for this campaign type (see documentation)","invalid.email.from.address.friendly.name":"The from address friendly name must be a between 1 and 64 characters long","constraint.validation":"%s","invalid.email.reply.to.address.route.pattern":"The reply-to address route must have a pattern configured","dnc.list.invalid.custom.exclusion.column":"The Custom Exclusion Column on one of the chosen DNC lists does not match any of the columns on the chosen Contact List","invalid.phone.column":"The phone column must be provided, and must be a valid column on the selected contact list","invalid.email.content.template.texts":"The content template must contain exactly two response texts","missing.email.content.template.body":"The content template must contain exactly one response text of type body","invalid.email.from.address":"The from address must be provided","dynamic.queueing.campaigns.count.exceeded":"The limit for dynamic queueing campaigns has been exceeded","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","sms.content.template.not.found":"The content template could not be found","contact.list.filter.mismatch":"The contact list on the contact list filter does not match the one on the campaign","invalid.email.reply.to.address.route":"The reply-to address route must be provided, and must be a route configured on the reply-to address domain","invalid.email.content.template.subject.content.type":"The content type of the content template subject must be 'text/plain'","contact.sort.duplicate.field.names":"Multiple Contact Sorts may not be applied to the same field","missing.phone.columns.in.contactlist":"The contact list must have at least one phone number column configured when the campaign is configured for SMS","contact.sort.size.exceeded":"A maximum of 4 Contact Sorts may be configured","invalid.sms.content.template.responsetype":"The response type of the content template must be 'CampaignSmsTemplate'","contact.sort.field.not.found":"One or more contact sort fields are not valid contact list columns","invalid.email.content.template.response.type":"The response type of the content template must be 'CampaignEmailTemplate'","invalid.email.columns":"The email columns must be provided, and all entries must be valid columns on the contact list","dnc.list.count.exceeded":"A maximum of 10 dnc lists may be configured","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.email.content.template.subject.content":"The content of the content template subject must not be blank","email.content.template.not.found":"The content template could not be found","dynamic.queueing.active.campaigns.count.exceeded":"The limit for active dynamic queueing campaigns has been exceeded","too.many.email.columns":"The limit for number of email columns has been exceeded. See details","too.many.contact.list.filters":"Only one contact list filter is allowed per campaign","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping","invalid.email.from.address.local.part":"The from address local part must be provided, and must be between 1 and 64 characters long","sms.content.template.mms.phone.number.type.not.supported":"The Content template with mms is not supported for the sms phone number type","sms.content.template.not.authorized":"The user does not have authorization to access the content template","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined","invalid.email.from.address.domain":"The from address domain must be provided, and must be a verified outbound domain registered with Genesys Cloud","contact.list.import.in.progress":"The contact list is still importing contacts","invalid.type.config":"Exactly one of [smsConfig] must be provided"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The messaging campaign could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:add","outbound:emailCampaign:add"]},"x-purecloud-method-name":"postOutboundMessagingcampaigns"}},"/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}":{"get":{"tags":["Outbound"],"summary":"Get an email campaign schedule.","description":"","operationId":"getOutboundSchedulesEmailcampaign","produces":["application/json"],"parameters":[{"name":"emailCampaignId","in":"path","description":"Email Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailCampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The email campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:emailCampaignSchedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesEmailcampaign"},"put":{"tags":["Outbound"],"summary":"Update an email campaign schedule.","description":"","operationId":"putOutboundSchedulesEmailcampaign","produces":["application/json"],"parameters":[{"name":"emailCampaignId","in":"path","description":"Email Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EmailCampaignSchedule","required":true,"schema":{"$ref":"#/definitions/EmailCampaignSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailCampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.interval.time":"The end time of each interval must be after its start time","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to create the email campaign schedule in an invalid way","recurrences.exceeded.limit":"The number of recurrences exceeds the limit.","invalid.number.of.occurrences":"The number of occurrences is a required field for numbered ranges and cannot exceed the limit.","recurrence.invalid.alteration.start.time":"The alteration start date must be a valid future date in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.end.time":"The end time of an interval must not be in the past","invalid.pattern.type":"The pattern type is a required field and must be a valid pattern type.","recurrence.invalid.end.time":"The end date must be a valid future date before the start date, in the format \"YYYY-MM-DDThh:mm:ss\"","constraint.validation":"%s","future.intervals.exceeded.limit":"The number of future intervals on the schedule must not exceed 500","invalid.update":"An attempt was made to update the email campaign schedule in an invalid way","invalid.alteration.type":"The alteration type is a required field and must be a valid alteration type.","recurrence.id.duplicate.found":"Duplicate recurrence ID found.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.range.end":"The range end date must be a valid future date, greater than the recurrence start date, and in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.timezone":"The time zone of a schedule must be a valid timezone string like ‘America/New_York’","invalid.pattern.interval":"The interval field is a required field and must be a number between 1 and the limit.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.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.","overlapping.interval":"Each interval must not overlap with any other interval","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.start.time":"The start time of an interval must not be in the past","recurrence.invalid.start.time":"The start date must be a valid future date in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.range.type":"The range type is a required field and must be a valid range type.","recurrence.id.not.allowed":"Recurrence ID is not allowed.","recurrence.invalid.alteration.end.time":"The alteration end date must be a valid future date before the start date, in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.associated.resource.type":"The associated resource type of a schedule must be 'emailcampaigns'"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The email campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:emailCampaignSchedule:edit"]},"x-purecloud-method-name":"putOutboundSchedulesEmailcampaign"},"delete":{"tags":["Outbound"],"summary":"Delete an email campaign schedule.","description":"","operationId":"deleteOutboundSchedulesEmailcampaign","produces":["application/json"],"parameters":[{"name":"emailCampaignId","in":"path","description":"Email Campaign ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The email campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:emailCampaignSchedule:delete"]},"x-purecloud-method-name":"deleteOutboundSchedulesEmailcampaign"}},"/api/v2/outbound/schedules/emailcampaigns":{"get":{"tags":["Outbound"],"summary":"Query for a list of email campaign schedules.","description":"","operationId":"getOutboundSchedulesEmailcampaigns","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailCampaignScheduleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:emailCampaignSchedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesEmailcampaigns"}},"/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}":{"get":{"tags":["Outbound"],"summary":"Get a messaging campaign schedule.","description":"","operationId":"getOutboundSchedulesMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The messaging campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaignSchedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesMessagingcampaign"},"put":{"tags":["Outbound"],"summary":"Update a new messaging campaign schedule.","description":"","operationId":"putOutboundSchedulesMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"Messaging Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"MessagingCampaignSchedule","required":true,"schema":{"$ref":"#/definitions/MessagingCampaignSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.interval.time":"The end time of each interval must be after its start time","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to create the messaging campaign schedule in an invalid way","recurrences.exceeded.limit":"The number of recurrences exceeds the limit.","invalid.number.of.occurrences":"The number of occurrences is a required field for numbered ranges and cannot exceed the limit.","recurrence.invalid.alteration.start.time":"The alteration start date must be a valid future date in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.end.time":"The end time of an interval must not be in the past","invalid.pattern.type":"The pattern type is a required field and must be a valid pattern type.","recurrence.invalid.end.time":"The end date must be a valid future date before the start date, in the format \"YYYY-MM-DDThh:mm:ss\"","constraint.validation":"%s","future.intervals.exceeded.limit":"The number of future intervals on the schedule must not exceed 500","invalid.update":"An attempt was made to update the messaging campaign schedule in an invalid way","invalid.alteration.type":"The alteration type is a required field and must be a valid alteration type.","recurrence.id.duplicate.found":"Duplicate recurrence ID found.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.range.end":"The range end date must be a valid future date, greater than the recurrence start date, and in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.timezone":"The time zone of a schedule must be a valid timezone string like ‘America/New_York’","invalid.pattern.interval":"The interval field is a required field and must be a number between 1 and the limit.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.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.","overlapping.interval":"Each interval must not overlap with any other interval","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.start.time":"The start time of an interval must not be in the past","recurrence.invalid.start.time":"The start date must be a valid future date in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.range.type":"The range type is a required field and must be a valid range type.","recurrence.id.not.allowed":"Recurrence ID is not allowed.","recurrence.invalid.alteration.end.time":"The alteration end date must be a valid future date before the start date, in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.associated.resource.type":"The associated resource type of the schedule must be 'messagingcampaigns'"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The messaging campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaignSchedule:edit"]},"x-purecloud-method-name":"putOutboundSchedulesMessagingcampaign"},"delete":{"tags":["Outbound"],"summary":"Delete a messaging campaign schedule.","description":"","operationId":"deleteOutboundSchedulesMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"Messaging Campaign ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The messaging campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaignSchedule:delete"]},"x-purecloud-method-name":"deleteOutboundSchedulesMessagingcampaign"}},"/api/v2/outbound/schedules/messagingcampaigns":{"get":{"tags":["Outbound"],"summary":"Query for a list of messaging campaign schedules.","description":"","operationId":"getOutboundSchedulesMessagingcampaigns","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignScheduleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaignSchedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesMessagingcampaigns"}},"/api/v2/mobiledevices/{deviceId}":{"get":{"tags":["Mobile Devices"],"summary":"Get device","description":"","operationId":"getMobiledevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"Device ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserDevice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a device with that deviceId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices","devices:readonly"]}],"x-purecloud-method-name":"getMobiledevice"},"put":{"tags":["Mobile Devices"],"summary":"Update device","description":"","operationId":"putMobiledevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"Device ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Device","required":false,"schema":{"$ref":"#/definitions/UserDevice"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserDevice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices"]}],"x-purecloud-method-name":"putMobiledevice"},"delete":{"tags":["Mobile Devices"],"summary":"Delete device","description":"","operationId":"deleteMobiledevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"Device ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices"]}],"x-purecloud-method-name":"deleteMobiledevice"}},"/api/v2/mobiledevices":{"get":{"tags":["Mobile Devices"],"summary":"Get a list of all devices.","description":"","operationId":"getMobiledevices","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DirectoryUserDevicesListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices","devices:readonly"]}],"x-purecloud-method-name":"getMobiledevices"},"post":{"tags":["Mobile Devices"],"summary":"Create User device","description":"","operationId":"postMobiledevices","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Device","required":true,"schema":{"$ref":"#/definitions/UserDevice"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserDevice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices"]}],"x-purecloud-method-name":"postMobiledevices"}},"/api/v2/fieldconfig":{"get":{"tags":["Users","Groups","Organization"],"summary":"Fetch field config for an entity type","description":"","operationId":"getFieldconfig","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"Field type","required":true,"type":"string","enum":["person","group","org"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FieldConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","bad.entity.type":"The entity type is invalid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getFieldconfig"}},"/api/v2/groups/{groupId}/individuals":{"get":{"tags":["Groups"],"summary":"Get all individuals associated with the group","description":"","operationId":"getGroupIndividuals","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroupIndividuals"}},"/api/v2/groups/{groupId}/members":{"get":{"tags":["Groups"],"summary":"Get group members, includes individuals, owners, and dynamically included people","description":"","operationId":"getGroupMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroupMembers"},"post":{"tags":["Groups"],"summary":"Add members","description":"","operationId":"postGroupMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Add members","required":true,"schema":{"$ref":"#/definitions/GroupMembersUpdate"}}],"responses":{"202":{"description":"Success, group membership was updated","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.resource.not.found":"Group members were not found.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Resource conflict updating members."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The version supplied does not match the current version of the user"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-purecloud-method-name":"postGroupMembers"},"delete":{"tags":["Groups"],"summary":"Remove members","description":"","operationId":"deleteGroupMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"ids","in":"query","description":"Comma separated list of userIds to remove","required":true,"type":"string"}],"responses":{"202":{"description":"Success, group membership was updated","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-purecloud-method-name":"deleteGroupMembers"}},"/api/v2/groups/{groupId}/profile":{"get":{"tags":["Groups"],"summary":"Get group profile","description":"This api is deprecated. Use /api/v2/groups instead","operationId":"getGroupProfile","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"groupId","required":true,"type":"string"},{"name":"fields","in":"query","description":"Comma separated fields to return. Allowable values can be found by querying /api/v2/fieldconfig?type=group and using the key for the elements returned by the fieldList","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the group profile","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getGroupProfile"}},"/api/v2/profiles/groups":{"get":{"tags":["Groups"],"summary":"Get group profile listing","description":"This api is deprecated. Use /api/v2/groups instead.","operationId":"getProfilesGroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"jabberId","in":"query","description":"A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupProfileEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getProfilesGroups"}},"/api/v2/groups/{groupId}":{"get":{"tags":["Groups"],"summary":"Get group","description":"","operationId":"getGroup","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a group with that groupId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroup"},"put":{"tags":["Groups"],"summary":"Update group","description":"","operationId":"putGroup","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Group","required":false,"schema":{"$ref":"#/definitions/GroupUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Unable to create a tab configuration due to invalid request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Resource conflict - Unexpected version was provided"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided"},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"putGroup"},"delete":{"tags":["Groups"],"summary":"Delete group","description":"","operationId":"deleteGroup","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","group.name.in.use":"This group name is currently in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Specified group not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:delete"]},"x-purecloud-method-name":"deleteGroup"}},"/api/v2/groups":{"get":{"tags":["Groups"],"summary":"Get a group list","description":"","operationId":"getGroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"jabberId","in":"query","description":"A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroups"},"post":{"tags":["Groups"],"summary":"Create a group","description":"","operationId":"postGroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Group","required":true,"schema":{"$ref":"#/definitions/GroupCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:add"]},"x-purecloud-method-name":"postGroups"}},"/api/v2/groups/search":{"get":{"tags":["Groups","Search"],"summary":"Search groups using the q64 value returned from a previous search","description":"","operationId":"getGroupsSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroupsSearch"},"post":{"tags":["Groups","Search"],"summary":"Search groups","description":"","operationId":"postGroupsSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/GroupSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-purecloud-method-name":"postGroupsSearch"}},"/api/v2/languages/{languageId}":{"get":{"tags":["Languages"],"summary":"Get Language (Deprecated)","description":"This endpoint is deprecated. Please see the Routing API (GET /api/v2/routing/languages/{languageId})","operationId":"getLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"getLanguage"},"delete":{"tags":["Languages"],"summary":"Delete Language (Deprecated)","description":"This endpoint is deprecated. Please see the Routing API (DELETE /api/v2/routing/languages/{languageId})","operationId":"deleteLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"deleteLanguage"}},"/api/v2/languages":{"get":{"tags":["Languages"],"summary":"Get the list of supported languages. (Deprecated)","description":"This endpoint is deprecated. Please see the Routing API (GET /api/v2/routing/languages)","operationId":"getLanguages","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"getLanguages"},"post":{"tags":["Languages"],"summary":"Create Language (Deprecated)","description":"This endpoint is deprecated. Please see the Routing API. (POST /api/v2/routing/languages","operationId":"postLanguages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Language","required":true,"schema":{"$ref":"#/definitions/Language"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"postLanguages"}},"/api/v2/locations/{locationId}":{"get":{"tags":["Locations"],"summary":"Get Location by ID.","description":"","operationId":"getLocation","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["images","addressVerificationDetails"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Location is not found by given location id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly"]}],"x-purecloud-method-name":"getLocation"},"delete":{"tags":["Locations"],"summary":"Delete a location","description":"","operationId":"deleteLocation","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"}],"responses":{"204":{"description":"The location was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"Unable to delete a location due to invalid request.","general.conflict":"Version does not match current version."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["directory:location:delete"]},"x-purecloud-method-name":"deleteLocation"},"patch":{"tags":["Locations"],"summary":"Update a location","description":"","operationId":"patchLocation","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Location","required":true,"schema":{"$ref":"#/definitions/LocationUpdateDefinition"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Unable to update a location due to invalid request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Unable to update a location due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["directory:location:edit"]},"x-purecloud-method-name":"patchLocation"}},"/api/v2/locations/{locationId}/sublocations":{"get":{"tags":["Locations"],"summary":"Get sublocations for location ID.","description":"","operationId":"getLocationSublocations","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly"]}],"x-purecloud-method-name":"getLocationSublocations"}},"/api/v2/locations":{"get":{"tags":["Locations"],"summary":"Get a list of all locations.","description":"","operationId":"getLocations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","enum":["asc","desc"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Unable to get a location due to invalid request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly"]}],"x-purecloud-method-name":"getLocations"},"post":{"tags":["Locations"],"summary":"Create a location","description":"","operationId":"postLocations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Location","required":true,"schema":{"$ref":"#/definitions/LocationCreateDefinition"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Unable to create a location due to invalid request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["directory:location:add"]},"x-purecloud-method-name":"postLocations"}},"/api/v2/locations/search":{"get":{"tags":["Locations","Search"],"summary":"Search locations using the q64 value returned from a previous search","description":"","operationId":"getLocationsSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"Provides more details about a specified resource","required":false,"type":"array","items":{"type":"string","enum":["images","addressVerificationDetails"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly","search:readonly"]}],"x-purecloud-method-name":"getLocationsSearch"},"post":{"tags":["Locations","Search"],"summary":"Search locations","description":"","operationId":"postLocationsSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/LocationSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly","search:readonly"]}],"x-purecloud-method-name":"postLocationsSearch"}},"/api/v2/organizations/features/{featureName}":{"patch":{"tags":["Organization"],"summary":"Update organization","description":"","operationId":"patchOrganizationsFeature","produces":["application/json"],"parameters":[{"name":"featureName","in":"path","description":"Organization feature","required":true,"type":"string","enum":["realtimeCIC","purecloud","hipaa","ucEnabled","pci","purecloudVoice","xmppFederation","chat","informalPhotos","directory","contactCenter","unifiedCommunications","custserv"]},{"in":"body","name":"enabled","description":"New state of feature","required":true,"schema":{"$ref":"#/definitions/FeatureState"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationFeatures"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"patchOrganizationsFeature"}},"/api/v2/organizations/me":{"get":{"tags":["Organization"],"summary":"Get organization.","description":"","operationId":"getOrganizationsMe","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsMe"},"put":{"tags":["Organization"],"summary":"Update organization.","description":"","operationId":"putOrganizationsMe","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization","required":false,"schema":{"$ref":"#/definitions/Organization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The version supplied does not match the current version of the user"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsMe"}},"/api/v2/users/{userId}/favorites":{"get":{"tags":["Users"],"summary":"Deprecated; will be revived with new contract","description":"","operationId":"getUserFavorites","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getUserFavorites"}},"/api/v2/users/{userId}/adjacents":{"get":{"tags":["Users"],"summary":"Get adjacents","description":"","operationId":"getUserAdjacents","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Adjacents"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserAdjacents"}},"/api/v2/users/{userId}/superiors":{"get":{"tags":["Users"],"summary":"Get superiors","description":"","operationId":"getUserSuperiors","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/User"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserSuperiors"}},"/api/v2/users/{userId}/directreports":{"get":{"tags":["Users"],"summary":"Get direct reports","description":"","operationId":"getUserDirectreports","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/User"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserDirectreports"}},"/api/v2/languages/translations/builtin":{"get":{"tags":["Languages"],"summary":"Get the builtin translation for a language","description":"","operationId":"getLanguagesTranslationsBuiltin","produces":["application/json"],"parameters":[{"name":"language","in":"query","description":"The language of the builtin translation to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslationsBuiltin"}},"/api/v2/languages/translations/organization":{"get":{"tags":["Languages"],"summary":"Get effective translation for an organization by language","description":"","operationId":"getLanguagesTranslationsOrganization","produces":["application/json"],"parameters":[{"name":"language","in":"query","description":"The language of the translation to retrieve for the organization","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslationsOrganization"}},"/api/v2/languages/translations":{"get":{"tags":["Languages"],"summary":"Get all available languages for translation","description":"","operationId":"getLanguagesTranslations","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableTranslations"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslations"}},"/api/v2/languages/translations/users/{userId}":{"get":{"tags":["Languages"],"summary":"Get effective language translation for a user","description":"","operationId":"getLanguagesTranslationsUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The user id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslationsUser"}},"/api/v2/users/{userId}/profile":{"get":{"tags":["Users"],"summary":"Get user profile","description":"This api has been deprecated. Use api/v2/users instead","operationId":"getUserProfile","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks"]},"collectionFormat":"multi"},{"name":"integrationPresenceSource","in":"query","description":"Gets an integration presence for a user instead of their default.","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","EightByEight"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the user profile","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getUserProfile"}},"/api/v2/profiles/users":{"get":{"tags":["Users"],"summary":"Get a user profile listing","description":"This api is deprecated. User /api/v2/users","operationId":"getProfilesUsers","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"jid","in":"query","description":"jid","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization"]},"collectionFormat":"multi"},{"name":"integrationPresenceSource","in":"query","description":"Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\".","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","EightByEight"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserProfileEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getProfilesUsers"}},"/api/v2/downloads/{downloadId}":{"get":{"tags":["Downloads"],"summary":"Issues a redirect to a signed secure download URL for specified download","description":"this method will issue a redirect to the url to the content","operationId":"getDownload","produces":["application/json"],"parameters":[{"name":"downloadId","in":"path","description":"Download ID","required":true,"type":"string"},{"name":"contentDisposition","in":"query","required":false,"type":"string"},{"name":"issueRedirect","in":"query","required":false,"type":"boolean","default":true},{"name":"redirectToAuth","in":"query","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","access.denied":"Access to download is denied.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Redirect URL is not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getDownload"}},"/api/v2/employeeperformance/externalmetrics/data":{"post":{"tags":["Gamification"],"summary":"Write External Metric Data","description":"","operationId":"postEmployeeperformanceExternalmetricsData","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The External Metric Data to be added","required":false,"schema":{"$ref":"#/definitions/ExternalMetricDataWriteRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalMetricDataWriteResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","employee.performance.external.metric.data.input.validation.error":"There was an error parsing argument","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.data.internal.service.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","employee.performance.external.metric.data.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["employee-performance"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["employeePerformance:externalMetricData:add"]},"x-purecloud-method-name":"postEmployeeperformanceExternalmetricsData"}},"/api/v2/employeeperformance/externalmetrics/definitions/{metricId}":{"get":{"tags":["Gamification"],"summary":"Get an External Metric Definition","description":"","operationId":"getEmployeeperformanceExternalmetricsDefinition","produces":["application/json"],"parameters":[{"name":"metricId","in":"path","description":"Specifies the External Metric Definition ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalMetricDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","employee.performance.external.metric.definition.input.validation.error":"There was an error parsing argument","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.not.found":"The operation failed because the metric definition was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.internal.service.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["employee-performance","employee-performance:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["employeePerformance:externalMetricDefinition:view"]},"x-purecloud-method-name":"getEmployeeperformanceExternalmetricsDefinition"},"delete":{"tags":["Gamification"],"summary":"Delete an External Metric Definition","description":"","operationId":"deleteEmployeeperformanceExternalmetricsDefinition","produces":["application/json"],"parameters":[{"name":"metricId","in":"path","description":"Specifies the External Metric Definition ID","required":true,"type":"string"}],"responses":{"204":{"description":"The External Metric Definition was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","employee.performance.external.metric.definition.input.validation.error":"There was an error parsing argument"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.not.found":"The operation failed because the metric definition was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.state.conflict.error":"The operation failed because the metric definition is in use"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.internal.service.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["employee-performance"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["employeePerformance:externalMetricDefinition:delete"]},"x-purecloud-method-name":"deleteEmployeeperformanceExternalmetricsDefinition"},"patch":{"tags":["Gamification"],"summary":"Update External Metric Definition","description":"","operationId":"patchEmployeeperformanceExternalmetricsDefinition","produces":["application/json"],"parameters":[{"name":"metricId","in":"path","description":"Specifies the metric definition ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The External Metric Definition parameters to be updated","required":true,"schema":{"$ref":"#/definitions/ExternalMetricDefinitionUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalMetricDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","employee.performance.external.metric.definition.input.validation.error":"There was an error parsing argument","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.not.found":"The operation failed because the metric definition was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.state.conflict.error":"The operation failed because the metric definition is in use and cannot be set to false"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.internal.service.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["employee-performance"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["employeePerformance:externalMetricDefinition:edit"]},"x-purecloud-method-name":"patchEmployeeperformanceExternalmetricsDefinition"}},"/api/v2/employeeperformance/externalmetrics/definitions":{"get":{"tags":["Gamification"],"summary":"Get a list of External Metric Definitions of an organization, sorted by name in ascending order","description":"","operationId":"getEmployeeperformanceExternalmetricsDefinitions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalMetricDefinitionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","employee.performance.external.metric.definition.input.validation.error":"There was an error parsing argument","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.internal.service.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["employee-performance","employee-performance:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["employeePerformance:externalMetricDefinition:view"]},"x-purecloud-method-name":"getEmployeeperformanceExternalmetricsDefinitions"},"post":{"tags":["Gamification"],"summary":"Create External Metric Definition","description":"","operationId":"postEmployeeperformanceExternalmetricsDefinitions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The External Metric Definition to be created","required":false,"schema":{"$ref":"#/definitions/ExternalMetricDefinitionCreateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalMetricDefinition"}},"201":{"description":"The External Metric Definition was successfully created","schema":{"$ref":"#/definitions/ExternalMetricDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","employee.performance.external.metric.definition.input.validation.error":"There was an error parsing argument","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","employee.performance.external.metric.definition.too.many.metric.definitions":"The operation failed as the maximum number of External Metric Definitions has been reached"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.internal.service.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["employee-performance"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["employeePerformance:externalMetricDefinition:add"]},"x-purecloud-method-name":"postEmployeeperformanceExternalmetricsDefinitions"}},"/api/v2/flows/instances/{instanceId}":{"get":{"tags":["Architect"],"summary":"Start a process (job) to prepare a download of a singular flow execution data instance by Id","description":"Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.","operationId":"getFlowsInstance","produces":["application/json"],"parameters":[{"name":"instanceId","in":"path","description":"Instance ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand various details.","required":false,"type":"string","enum":["bots","dataActions"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetFlowExecutionDataJobResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowInstance:view"]},"x-purecloud-method-name":"getFlowsInstance"}},"/api/v2/flows/instances/jobs/{jobId}":{"get":{"tags":["Architect"],"summary":"Get the status and/or results of an asynchronous flow execution data retrieval job","description":"","operationId":"getFlowsInstancesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The asynchronous job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetFlowExecutionDataJobResult"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/GetFlowExecutionDataJobResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowInstance:view"]},"x-purecloud-method-name":"getFlowsInstancesJob"}},"/api/v2/flows/instances/jobs":{"post":{"tags":["Architect"],"summary":"Start a process (job) that will prepare a list of execution data IDs for download.","description":"Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.","operationId":"postFlowsInstancesJobs","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand various query types.","required":false,"type":"string","enum":["bots","dataActions"]},{"in":"body","name":"body","description":"Requested Flow Ids","required":true,"schema":{"$ref":"#/definitions/ExecutionDataRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetFlowExecutionDataJobResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowInstance:view"]},"x-purecloud-method-name":"postFlowsInstancesJobs"}},"/api/v2/flows/instances/querycapabilities":{"get":{"tags":["Architect"],"summary":"Retrieve a list of capabilities that the org can use to query for execution data","description":"Returns the queryable parameters that can be used to build a query for execution data.","operationId":"getFlowsInstancesQuerycapabilities","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand various query types.","required":false,"type":"string","enum":["flow","action"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowsQueryCriteriaResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowInstance:search"]},"x-purecloud-method-name":"getFlowsInstancesQuerycapabilities"}},"/api/v2/flows/instances/query":{"post":{"tags":["Architect"],"summary":"Query the database of existing flow histories to look for particular flow criteria","description":"Returns a list of matching flow histories up to 200 max.","operationId":"postFlowsInstancesQuery","produces":["application/json"],"parameters":[{"name":"indexOnly","in":"query","description":"indexes only","required":false,"type":"boolean"},{"name":"pageSize","in":"query","description":"number of results to return","required":false,"type":"integer","default":50,"format":"int32"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/CriteriaQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowResultEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowInstance:search"]},"x-purecloud-method-name":"postFlowsInstancesQuery"}},"/api/v2/flows/instances/settings/executiondata":{"get":{"tags":["Architect"],"summary":"Get the execution history enabled setting.","description":"Get the execution history enabled setting.","operationId":"getFlowsInstancesSettingsExecutiondata","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExecutionDataFlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowinstanceexecutiondata:view"]},"x-purecloud-method-name":"getFlowsInstancesSettingsExecutiondata"},"patch":{"tags":["Architect"],"summary":"Edit the execution history enabled setting.","description":"Edit the execution history enabled setting.","operationId":"patchFlowsInstancesSettingsExecutiondata","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"New Execution Data Setting","required":true,"schema":{"$ref":"#/definitions/ExecutionDataSettingsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExecutionDataFlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowinstanceexecutiondata:edit"]},"x-purecloud-method-name":"patchFlowsInstancesSettingsExecutiondata"}},"/api/v2/flows/instances/settings/loglevels/default":{"get":{"tags":["Architect"],"summary":"Returns the flow default log level.","description":"Returns the flow default log level which will be used if no specific flow id log level is found.","operationId":"getFlowsInstancesSettingsLoglevelsDefault","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"array","items":{"type":"string","enum":["logLevelCharacteristics.characteristics"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowLogLevelDefault:view"]},"x-purecloud-method-name":"getFlowsInstancesSettingsLoglevelsDefault"},"put":{"tags":["Architect"],"summary":"Edit the flow default log level.","description":"Edit the flow default log level.","operationId":"putFlowsInstancesSettingsLoglevelsDefault","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"array","items":{"type":"string","enum":["logLevelCharacteristics.characteristics"]},"collectionFormat":"multi"},{"in":"body","name":"body","description":"New LogLevel settings","required":true,"schema":{"$ref":"#/definitions/FlowLogLevelRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowLogLevelDefault:edit"]},"x-purecloud-method-name":"putFlowsInstancesSettingsLoglevelsDefault"},"delete":{"tags":["Architect"],"summary":"Resets the org log level to default, base","description":"Resets the org log level to default, base","operationId":"deleteFlowsInstancesSettingsLoglevelsDefault","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"The loglevel was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowLogLevelDefault:delete"]},"x-purecloud-method-name":"deleteFlowsInstancesSettingsLoglevelsDefault"}},"/api/v2/flows/{flowId}/instances/settings/loglevels":{"get":{"tags":["Architect"],"summary":"Retrieves the log level for a flow by flow id.","description":"Retrieves the log level for a flow by flow id.","operationId":"getFlowInstancesSettingsLoglevels","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"The flow id to get the loglevel for","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"array","items":{"type":"string","enum":["name","type","logLevelCharacteristics.characteristics"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowLogLevel:view"]},"x-purecloud-method-name":"getFlowInstancesSettingsLoglevels"},"post":{"tags":["Architect"],"summary":"Set the logLevel for a particular flow id","description":"Assigns a new loglevel to a flow id","operationId":"postFlowInstancesSettingsLoglevels","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"array","items":{"type":"string","enum":["name","type","logLevelCharacteristics.characteristics"]},"collectionFormat":"multi"},{"name":"flowId","in":"path","description":"The flow id to set the loglevel for","required":true,"type":"string"},{"in":"body","name":"body","description":"New LogLevel settings","required":true,"schema":{"$ref":"#/definitions/FlowLogLevelRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowLogLevel:add"]},"x-purecloud-method-name":"postFlowInstancesSettingsLoglevels"},"put":{"tags":["Architect"],"summary":"Edit the logLevel for a particular flow id","description":"Updates the loglevel for a flow id","operationId":"putFlowInstancesSettingsLoglevels","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"array","items":{"type":"string","enum":["name","type","logLevelCharacteristics.characteristics"]},"collectionFormat":"multi"},{"name":"flowId","in":"path","description":"The flow id to edit the loglevel for","required":true,"type":"string"},{"in":"body","name":"body","description":"New LogLevel settings","required":true,"schema":{"$ref":"#/definitions/FlowLogLevelRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowLogLevel:edit"]},"x-purecloud-method-name":"putFlowInstancesSettingsLoglevels"},"delete":{"tags":["Architect"],"summary":"Deletes a log level for a flow by flow id.","description":"Deletes the associated log level for a flow by flow id","operationId":"deleteFlowInstancesSettingsLoglevels","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"The flow id to delete the loglevel for","required":true,"type":"string"}],"responses":{"204":{"description":"The loglevel was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowLogLevel:delete"]},"x-purecloud-method-name":"deleteFlowInstancesSettingsLoglevels"}},"/api/v2/flows/instances/settings/loglevels/characteristics":{"get":{"tags":["Architect"],"summary":"Gets the available flow log level characteristics for this organization.","description":"Log levels can be customized and this returns the set of available characteristics that can be enabled/disabled.","operationId":"getFlowsInstancesSettingsLoglevelsCharacteristics","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowLogLevelCharacteristicsDefinitions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowLogLevel:view","architect:flowLogLevelDefault:view"]},"x-purecloud-method-name":"getFlowsInstancesSettingsLoglevelsCharacteristics"}},"/api/v2/flows/instances/settings/loglevels":{"get":{"tags":["Architect"],"summary":"Retrieve a list of LogLevels for the organization.","description":"Returns a paged set of LogLevels per flow id","operationId":"getFlowsInstancesSettingsLoglevels","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"array","items":{"type":"string","enum":["name","type","logLevelCharacteristics.characteristics"]},"collectionFormat":"multi"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowSettingsResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowLogLevel:view","architect:flow:search"]},"x-purecloud-method-name":"getFlowsInstancesSettingsLoglevels"}},"/api/v2/fax/settings":{"get":{"tags":["Fax"],"summary":"Get organization config for given organization","description":"","operationId":"getFaxSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fax.status.not.found":"Organization config not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxSettings"},"put":{"tags":["Fax"],"summary":"Update/write organization config for given organization","description":"","operationId":"putFaxSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FaxConfig"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Submitted config is either null or contains a null field","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putFaxSettings"}},"/api/v2/fax/documents/{documentId}/content":{"get":{"tags":["Fax"],"summary":"Download a fax document.","description":"","operationId":"getFaxDocumentContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DownloadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxDocumentContent"}},"/api/v2/fax/documents/{documentId}":{"get":{"tags":["Fax"],"summary":"Get a document.","description":"","operationId":"getFaxDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Access to a document is not permitted by given document id.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxDocument"},"put":{"tags":["Fax"],"summary":"Update a fax document.","description":"","operationId":"putFaxDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Document","required":true,"schema":{"$ref":"#/definitions/FaxDocument"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax"]}],"x-purecloud-method-name":"putFaxDocument"},"delete":{"tags":["Fax"],"summary":"Delete a fax document.","description":"","operationId":"deleteFaxDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax"]}],"x-purecloud-method-name":"deleteFaxDocument"}},"/api/v2/fax/documents":{"get":{"tags":["Fax"],"summary":"Get a list of fax documents.","description":"","operationId":"getFaxDocuments","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Access to a list of fax documents is not permitted.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxDocuments"}},"/api/v2/fax/summary":{"get":{"tags":["Fax"],"summary":"Get fax summary","description":"","operationId":"getFaxSummary","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSummary"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxSummary"}},"/api/v2/gamification/status":{"get":{"tags":["Gamification"],"summary":"Gamification activation status","description":"","operationId":"getGamificationStatus","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GamificationStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:profile:update","gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationStatus"},"put":{"tags":["Gamification"],"summary":"Update gamification activation status","description":"","operationId":"putGamificationStatus","produces":["application/json"],"parameters":[{"in":"body","name":"status","description":"Gamification status","required":true,"schema":{"$ref":"#/definitions/GamificationStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GamificationStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"putGamificationStatus"}},"/api/v2/gamification/leaderboard/bestpoints":{"get":{"tags":["Gamification"],"summary":"Best Points of the requesting user's current performance profile or division","description":"","operationId":"getGamificationLeaderboardBestpoints","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OverallBestPoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:leaderboard:view"]},"x-purecloud-method-name":"getGamificationLeaderboardBestpoints"}},"/api/v2/gamification/leaderboard/all":{"get":{"tags":["Gamification"],"summary":"Leaderboard by filter type","description":"","operationId":"getGamificationLeaderboardAll","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type. For example, division or performance profile Id","required":true,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"metricId","in":"query","description":"Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Leaderboard"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:leaderboard:viewAll"]},"x-purecloud-method-name":"getGamificationLeaderboardAll"}},"/api/v2/gamification/leaderboard":{"get":{"tags":["Gamification"],"summary":"Leaderboard of the requesting user's division or performance profile","description":"","operationId":"getGamificationLeaderboard","produces":["application/json"],"parameters":[{"name":"startWorkday","in":"query","description":"Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"metricId","in":"query","description":"Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Leaderboard"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:leaderboard:view"]},"x-purecloud-method-name":"getGamificationLeaderboard"}},"/api/v2/gamification/leaderboard/all/bestpoints":{"get":{"tags":["Gamification"],"summary":"Best Points by division or performance profile","description":"","operationId":"getGamificationLeaderboardAllBestpoints","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type. For example, division or performance profile Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OverallBestPoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:leaderboard:viewAll"]},"x-purecloud-method-name":"getGamificationLeaderboardAllBestpoints"}},"/api/v2/gamification/metricdefinitions/{metricDefinitionId}":{"get":{"tags":["Gamification"],"summary":"Metric definition by id","description":"","operationId":"getGamificationMetricdefinition","produces":["application/json"],"parameters":[{"name":"metricDefinitionId","in":"path","description":"metric definition id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MetricDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view"]},"x-purecloud-method-name":"getGamificationMetricdefinition"}},"/api/v2/gamification/metricdefinitions":{"get":{"tags":["Gamification"],"summary":"All metric definitions","description":"Retrieves the metric definitions and their corresponding default objectives used to create a gamified metric","operationId":"getGamificationMetricdefinitions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetMetricDefinitionsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view"]},"x-purecloud-method-name":"getGamificationMetricdefinitions"}},"/api/v2/gamification/templates/{templateId}":{"get":{"tags":["Gamification"],"summary":"Objective template by id","description":"","operationId":"getGamificationTemplate","produces":["application/json"],"parameters":[{"name":"templateId","in":"path","description":"template id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ObjectiveTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view"]},"x-purecloud-method-name":"getGamificationTemplate"}},"/api/v2/gamification/templates":{"get":{"tags":["Gamification"],"summary":"All objective templates","description":"","operationId":"getGamificationTemplates","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetTemplatesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view"]},"x-purecloud-method-name":"getGamificationTemplates"}},"/api/v2/gamification/profiles/users/me/query":{"post":{"tags":["Gamification"],"summary":"Query performance profiles in date range for the current user","description":"","operationId":"postGamificationProfilesUsersMeQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The date range of work day.","required":true,"schema":{"$ref":"#/definitions/UserProfilesInDateRangeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserProfilesInDateRange"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-purecloud-method-name":"postGamificationProfilesUsersMeQuery"}},"/api/v2/gamification/profiles/users/{userId}/query":{"post":{"tags":["Gamification"],"summary":"Query performance profiles in date range for a user","description":"","operationId":"postGamificationProfilesUserQuery","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user.","required":true,"type":"string"},{"in":"body","name":"body","description":"The date range of work day.","required":true,"schema":{"$ref":"#/definitions/UserProfilesInDateRangeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserProfilesInDateRange"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:agentProfileMembership:view"]},"x-purecloud-method-name":"postGamificationProfilesUserQuery"}},"/api/v2/gamification/profiles/{profileId}":{"get":{"tags":["Gamification"],"summary":"Performance profile by id","description":"","operationId":"getGamificationProfile","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:leaderboard:viewAll","gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationProfile"},"put":{"tags":["Gamification"],"summary":"Updates a performance profile","description":"","operationId":"putGamificationProfile","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"},{"in":"body","name":"body","description":"performanceProfile","required":false,"schema":{"$ref":"#/definitions/PerformanceProfile"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"putGamificationProfile"}},"/api/v2/gamification/profiles/{profileId}/activate":{"post":{"tags":["Gamification"],"summary":"Activate a performance profile","description":"","operationId":"postGamificationProfileActivate","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfileActivate"}},"/api/v2/gamification/profiles/{profileId}/deactivate":{"post":{"tags":["Gamification"],"summary":"Deactivate a performance profile","description":"","operationId":"postGamificationProfileDeactivate","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfileDeactivate"}},"/api/v2/gamification/profiles/users/me":{"get":{"tags":["Gamification"],"summary":"Performance profile of the requesting user","description":"","operationId":"getGamificationProfilesUsersMe","produces":["application/json"],"parameters":[{"name":"workday","in":"query","description":"Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-purecloud-method-name":"getGamificationProfilesUsersMe"}},"/api/v2/gamification/profiles/users/{userId}":{"get":{"tags":["Gamification"],"summary":"Performance profile of a user","description":"","operationId":"getGamificationProfilesUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"workday","in":"query","description":"Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:scorecard:viewAll","gamification:leaderboard:viewAll"]},"x-purecloud-method-name":"getGamificationProfilesUser"}},"/api/v2/gamification/profiles":{"get":{"tags":["Gamification"],"summary":"All performance profiles","description":"","operationId":"getGamificationProfiles","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetProfilesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:leaderboard:viewAll","gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationProfiles"},"post":{"tags":["Gamification"],"summary":"Create a new custom performance profile","description":"","operationId":"postGamificationProfiles","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"performanceProfile","required":true,"schema":{"$ref":"#/definitions/CreatePerformanceProfile"}},{"name":"copyMetrics","in":"query","description":"Flag to copy metrics. If set to false, there will be no metrics associated with the new profile. If set to true or is absent (the default behavior), all metrics from the default profile will be copied over into the new profile.","required":false,"type":"boolean","default":true}],"responses":{"201":{"description":"Performance Profile successfully created","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfiles"}},"/api/v2/gamification/profiles/{sourceProfileId}/metrics/{sourceMetricId}/link":{"post":{"tags":["Gamification"],"summary":"Creates a linked metric","description":"","operationId":"postGamificationProfileMetricLink","produces":["application/json"],"parameters":[{"name":"sourceProfileId","in":"path","description":"Source Performance Profile Id","required":true,"type":"string"},{"name":"sourceMetricId","in":"path","description":"Source Metric Id","required":true,"type":"string"},{"in":"body","name":"body","description":"linkedMetric","required":true,"schema":{"$ref":"#/definitions/TargetPerformanceProfile"}}],"responses":{"201":{"description":"Linked Metric successfully created","schema":{"$ref":"#/definitions/Metric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfileMetricLink"}},"/api/v2/gamification/profiles/{profileId}/metrics/{metricId}":{"get":{"tags":["Gamification"],"summary":"Performance profile gamified metric by id","description":"","operationId":"getGamificationProfileMetric","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Performance Profile Id","required":true,"type":"string"},{"name":"metricId","in":"path","description":"Metric Id","required":true,"type":"string"},{"name":"workday","in":"query","description":"The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Metric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:leaderboard:view","gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationProfileMetric"},"put":{"tags":["Gamification"],"summary":"Updates a metric in performance profile","description":"","operationId":"putGamificationProfileMetric","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Performance Profile Id","required":true,"type":"string"},{"name":"metricId","in":"path","description":"Metric Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Metric","required":true,"schema":{"$ref":"#/definitions/CreateMetric"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Metric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"putGamificationProfileMetric"}},"/api/v2/gamification/profiles/{profileId}/metrics/objectivedetails":{"get":{"tags":["Gamification"],"summary":"All metrics for a given performance profile with objective details such as order and maxPoints","description":"","operationId":"getGamificationProfileMetricsObjectivedetails","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Performance Profile Id","required":true,"type":"string"},{"name":"workday","in":"query","description":"The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetMetricsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:leaderboard:view","gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationProfileMetricsObjectivedetails"}},"/api/v2/gamification/profiles/{profileId}/metrics":{"get":{"tags":["Gamification"],"summary":"All gamified metrics for a given performance profile","description":"","operationId":"getGamificationProfileMetrics","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Performance Profile Id","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["objective"]},"collectionFormat":"multi"},{"name":"workday","in":"query","description":"The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"metricIds","in":"query","description":"List of metric ids to filter the response (Optional, comma-separated).","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetMetricResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:leaderboard:view","gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationProfileMetrics"},"post":{"tags":["Gamification"],"summary":"Creates a gamified metric with a given metric definition and metric objective under in a performance profile","description":"","operationId":"postGamificationProfileMetrics","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Performance Profile Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Metric","required":true,"schema":{"$ref":"#/definitions/CreateMetric"}}],"responses":{"201":{"description":"Metric successfully created","schema":{"$ref":"#/definitions/Metric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfileMetrics"}},"/api/v2/gamification/insights/users/{userId}/details":{"get":{"tags":["Gamification"],"summary":"Get insights details for the user","description":"","operationId":"getGamificationInsightsUserDetails","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user.","required":true,"type":"string"},{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Weekly","Monthly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InsightsDetails"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:viewAll"]},"x-purecloud-method-name":"getGamificationInsightsUserDetails"}},"/api/v2/gamification/insights/details":{"get":{"tags":["Gamification"],"summary":"Get insights details for the current user","description":"","operationId":"getGamificationInsightsDetails","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Weekly","Monthly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InsightsDetails"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"The number of agent to rank over limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:view"]},"x-purecloud-method-name":"getGamificationInsightsDetails"}},"/api/v2/gamification/insights/members":{"get":{"tags":["Gamification"],"summary":"Query users in a profile during a period of time","description":"","operationId":"getGamificationInsightsMembers","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Weekly","Monthly"]},{"name":"startWorkday","in":"query","description":"The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InsightsAgents"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:viewAll"]},"x-purecloud-method-name":"getGamificationInsightsMembers"}},"/api/v2/gamification/insights/groups/trends/all":{"get":{"tags":["Gamification"],"summary":"Get insights overall trend","description":"","operationId":"getGamificationInsightsGroupsTrendsAll","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Daily","Weekly","Monthly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"comparativePeriodEndWorkday","in":"query","description":"The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodEndWorkday","in":"query","description":"The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InsightsTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:viewAll"]},"x-purecloud-method-name":"getGamificationInsightsGroupsTrendsAll"}},"/api/v2/gamification/insights/groups/trends":{"get":{"tags":["Gamification"],"summary":"Get insights overall trend for the current user","description":"","operationId":"getGamificationInsightsGroupsTrends","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Daily","Weekly","Monthly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"comparativePeriodEndWorkday","in":"query","description":"The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodEndWorkday","in":"query","description":"The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InsightsTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:view"]},"x-purecloud-method-name":"getGamificationInsightsGroupsTrends"}},"/api/v2/gamification/insights":{"get":{"tags":["Gamification"],"summary":"Get insights summary","description":"","operationId":"getGamificationInsights","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Weekly","Monthly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortKey","in":"query","description":"Sort key","required":false,"type":"string","enum":["percentOfGoal","percentOfGoalChange","overallPercentOfGoal","overallPercentOfGoalChange","value","valueChange"]},{"name":"sortMetricId","in":"query","description":"Sort Metric Id","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"userIds","in":"query","description":"A list of up to 100 comma-separated user Ids","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InsightsSummary"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:viewAll"]},"x-purecloud-method-name":"getGamificationInsights"}},"/api/v2/gamification/insights/trends":{"get":{"tags":["Gamification"],"summary":"Get insights user trend for the current user","description":"","operationId":"getGamificationInsightsTrends","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Daily","Weekly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"comparativePeriodEndWorkday","in":"query","description":"The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodEndWorkday","in":"query","description":"The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserInsightsTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:view"]},"x-purecloud-method-name":"getGamificationInsightsTrends"}},"/api/v2/gamification/insights/users/{userId}/trends":{"get":{"tags":["Gamification"],"summary":"Get insights user trend for the user","description":"","operationId":"getGamificationInsightsUserTrends","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user.","required":true,"type":"string"},{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Daily","Weekly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"comparativePeriodEndWorkday","in":"query","description":"The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodEndWorkday","in":"query","description":"The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserInsightsTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:viewAll"]},"x-purecloud-method-name":"getGamificationInsightsUserTrends"}},"/api/v2/gamification/profiles/{profileId}/members":{"get":{"tags":["Gamification"],"summary":"Members of a given performance profile","description":"","operationId":"getGamificationProfileMembers","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Profile Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MemberListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view"]},"x-purecloud-method-name":"getGamificationProfileMembers"},"post":{"tags":["Gamification"],"summary":"Assign members to a given performance profile","description":"","operationId":"postGamificationProfileMembers","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Profile Id","required":true,"type":"string"},{"in":"body","name":"body","description":"assignUsers","required":true,"schema":{"$ref":"#/definitions/AssignUsers"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Assignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfileMembers"}},"/api/v2/gamification/profiles/{profileId}/members/validate":{"post":{"tags":["Gamification"],"summary":"Validate member assignment","description":"","operationId":"postGamificationProfileMembersValidate","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Profile Id","required":true,"type":"string"},{"in":"body","name":"body","description":"memberAssignments","required":true,"schema":{"$ref":"#/definitions/ValidateAssignUsers"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignmentValidation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfileMembersValidate"}},"/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends":{"get":{"tags":["Gamification"],"summary":"Average performance values trends by metric of the requesting user","description":"","operationId":"getGamificationScorecardsProfileMetricValuesTrends","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"},{"name":"metricId","in":"path","description":"metricId","required":true,"type":"string"},{"name":"filterType","in":"query","description":"Filter type for the query request. If not set, returns the values trends of the requesting user","required":false,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"referenceWorkday","in":"query","description":"Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MetricValueTrendAverage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsProfileMetricValuesTrends"}},"/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends":{"get":{"tags":["Gamification"],"summary":"Average performance values trends by metric of a division or a performance profile","description":"","operationId":"getGamificationScorecardsProfileMetricUsersValuesTrends","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"},{"name":"metricId","in":"path","description":"metricId","required":true,"type":"string"},{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type. Only required when filterType is Division.","required":false,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"referenceWorkday","in":"query","description":"Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MetricValueTrendAverage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsProfileMetricUsersValuesTrends"}},"/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends":{"get":{"tags":["Gamification"],"summary":"Average performance values trends by metric of a user","description":"","operationId":"getGamificationScorecardsProfileMetricUserValuesTrends","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"},{"name":"metricId","in":"path","description":"metricId","required":true,"type":"string"},{"name":"userId","in":"path","required":true,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"referenceWorkday","in":"query","description":"Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MetricValueTrendAverage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.timezone.id":"Invalid timezone ID.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsProfileMetricUserValuesTrends"}},"/api/v2/gamification/scorecards":{"get":{"tags":["Gamification"],"summary":"Workday performance metrics of the requesting user","description":"","operationId":"getGamificationScorecards","produces":["application/json"],"parameters":[{"name":"workday","in":"query","description":"Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["objective"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayMetricListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecards"}},"/api/v2/gamification/scorecards/attendance":{"get":{"tags":["Gamification"],"summary":"Attendance status metrics of the requesting user","description":"","operationId":"getGamificationScorecardsAttendance","produces":["application/json"],"parameters":[{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttendanceStatusListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsAttendance"}},"/api/v2/gamification/scorecards/bestpoints":{"get":{"tags":["Gamification"],"summary":"Best points of the requesting user","description":"","operationId":"getGamificationScorecardsBestpoints","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserBestPoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsBestpoints"}},"/api/v2/gamification/scorecards/points/alltime":{"get":{"tags":["Gamification"],"summary":"All-time points of the requesting user","description":"","operationId":"getGamificationScorecardsPointsAlltime","produces":["application/json"],"parameters":[{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AllTimePoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsPointsAlltime"}},"/api/v2/gamification/scorecards/points/average":{"get":{"tags":["Gamification"],"summary":"Average points of the requesting user's division or performance profile","description":"","operationId":"getGamificationScorecardsPointsAverage","produces":["application/json"],"parameters":[{"name":"workday","in":"query","description":"The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SingleWorkdayAveragePoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsPointsAverage"}},"/api/v2/gamification/scorecards/points/trends":{"get":{"tags":["Gamification"],"summary":"Points trends of the requesting user","description":"","operationId":"getGamificationScorecardsPointsTrends","produces":["application/json"],"parameters":[{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"dayOfWeek","in":"query","description":"Optional filter to specify which day of weeks to be included in the response","required":false,"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayPointsTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsPointsTrends"}},"/api/v2/gamification/scorecards/values/trends":{"get":{"tags":["Gamification"],"summary":"Values trends of the requesting user or group","description":"","operationId":"getGamificationScorecardsValuesTrends","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request. If not set, then the request is for the requesting user.","required":false,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"referenceWorkday","in":"query","description":"Reference workday for the trend. Used to determine the profile of the user as of this date. If not set, then the user's current profile will be used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayValuesTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.timezone.id":"Invalid timezone ID.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsValuesTrends"}},"/api/v2/gamification/scorecards/values/average":{"get":{"tags":["Gamification"],"summary":"Average values of the requesting user's division or performance profile","description":"","operationId":"getGamificationScorecardsValuesAverage","produces":["application/json"],"parameters":[{"name":"workday","in":"query","description":"The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SingleWorkdayAverageValues"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.timezone.id":"An invalid timezone was provided","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsValuesAverage"}},"/api/v2/gamification/scorecards/users/{userId}":{"get":{"tags":["Gamification"],"summary":"Workday performance metrics for a user","description":"","operationId":"getGamificationScorecardsUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"workday","in":"query","description":"Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["objective"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayMetricListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUser"}},"/api/v2/gamification/scorecards/users/{userId}/bestpoints":{"get":{"tags":["Gamification"],"summary":"Best points of a user","description":"","operationId":"getGamificationScorecardsUserBestpoints","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserBestPoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUserBestpoints"}},"/api/v2/gamification/scorecards/users/{userId}/attendance":{"get":{"tags":["Gamification"],"summary":"Attendance status metrics for a user","description":"","operationId":"getGamificationScorecardsUserAttendance","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttendanceStatusListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.timezone.id":"The timezone ID was invalid.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUserAttendance"}},"/api/v2/gamification/scorecards/users/{userId}/points/trends":{"get":{"tags":["Gamification"],"summary":"Points trend for a user","description":"","operationId":"getGamificationScorecardsUserPointsTrends","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"dayOfWeek","in":"query","description":"Optional filter to specify which day of weeks to be included in the response","required":false,"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayPointsTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUserPointsTrends"}},"/api/v2/gamification/scorecards/users/{userId}/points/alltime":{"get":{"tags":["Gamification"],"summary":"All-time points for a user","description":"","operationId":"getGamificationScorecardsUserPointsAlltime","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AllTimePoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUserPointsAlltime"}},"/api/v2/gamification/scorecards/users/{userId}/values/trends":{"get":{"tags":["Gamification"],"summary":"Values trends of a user","description":"","operationId":"getGamificationScorecardsUserValuesTrends","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayValuesTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUserValuesTrends"}},"/api/v2/gamification/scorecards/users/points/average":{"get":{"tags":["Gamification"],"summary":"Workday average points by target group","description":"","operationId":"getGamificationScorecardsUsersPointsAverage","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"workday","in":"query","description":"The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SingleWorkdayAveragePoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUsersPointsAverage"}},"/api/v2/gamification/scorecards/users/values/average":{"get":{"tags":["Gamification"],"summary":"Workday average values by target group","description":"","operationId":"getGamificationScorecardsUsersValuesAverage","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type. For example, division Id","required":true,"type":"string"},{"name":"workday","in":"query","description":"The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SingleWorkdayAverageValues"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.timezone.id":"An invalid timezone was provided","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUsersValuesAverage"}},"/api/v2/gamification/scorecards/users/values/trends":{"get":{"tags":["Gamification"],"summary":"Values trend by target group","description":"","operationId":"getGamificationScorecardsUsersValuesTrends","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayValuesTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.timezone.id":"An invalid timezone was provided","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUsersValuesTrends"}},"/api/v2/gdpr/requests/{requestId}":{"get":{"tags":["General Data Protection Regulation"],"summary":"Get an existing GDPR request","description":"","operationId":"getGdprRequest","produces":["application/json"],"parameters":[{"name":"requestId","in":"path","description":"Request id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr","gdpr:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:request:view"]},"x-purecloud-method-name":"getGdprRequest"}},"/api/v2/gdpr/requests":{"get":{"tags":["General Data Protection Regulation"],"summary":"Get all GDPR requests","description":"","operationId":"getGdprRequests","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRRequestEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr","gdpr:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:request:view"]},"x-purecloud-method-name":"getGdprRequests"},"post":{"tags":["General Data Protection Regulation"],"summary":"Submit a new GDPR request","description":"","operationId":"postGdprRequests","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"GDPR request","required":true,"schema":{"$ref":"#/definitions/GDPRRequest"}},{"name":"deleteConfirmed","in":"query","description":"Confirm delete","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRRequest"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/GDPRRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:request:add"]},"x-purecloud-method-name":"postGdprRequests"}},"/api/v2/gdpr/subjects":{"get":{"tags":["General Data Protection Regulation"],"summary":"Get GDPR subjects","description":"","operationId":"getGdprSubjects","produces":["application/json"],"parameters":[{"name":"searchType","in":"query","description":"Search Type","required":true,"type":"string","enum":["NAME","ADDRESS","PHONE","EMAIL","TWITTER"]},{"name":"searchValue","in":"query","description":"Search Value","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRSubjectEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr","gdpr:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:subject:view"]},"x-purecloud-method-name":"getGdprSubjects"}},"/api/v2/users/{userId}/geolocations/{clientId}":{"get":{"tags":["Geolocation","Users"],"summary":"Get a user's Geolocation","description":"","operationId":"getUserGeolocation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"clientId","in":"path","description":"client Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Geolocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation","geolocation:readonly"]}],"x-purecloud-method-name":"getUserGeolocation"},"patch":{"tags":["Geolocation","Users"],"summary":"Patch a user's Geolocation","description":"The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.","operationId":"patchUserGeolocation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"clientId","in":"path","description":"client Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Geolocation","required":true,"schema":{"$ref":"#/definitions/Geolocation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Geolocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","geolocationservice.entitypointerror":"Geolocation entity point error","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","geolocation.update.error":"Cannot update another user's Geolocation.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"featuretoggleservice.featurenotenabled":"Geolocation feature toggle not enabled"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation"]}],"x-purecloud-method-name":"patchUserGeolocation"}},"/api/v2/geolocations/settings":{"get":{"tags":["Geolocation"],"summary":"Get a organization's GeolocationSettings","description":"","operationId":"getGeolocationsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeolocationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation","geolocation:readonly"]}],"x-purecloud-method-name":"getGeolocationsSettings"},"patch":{"tags":["Geolocation"],"summary":"Patch a organization's GeolocationSettings","description":"","operationId":"patchGeolocationsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Geolocation settings","required":true,"schema":{"$ref":"#/definitions/GeolocationSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeolocationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["geolocation:settings:edit"]},"x-purecloud-method-name":"patchGeolocationsSettings"}},"/api/v2/greetings/{greetingId}/media":{"get":{"tags":["Greetings"],"summary":"Get media playback URI for this greeting","description":"","operationId":"getGreetingMedia","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WAV","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GreetingMediaInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreetingMedia"}},"/api/v2/greetings/{greetingId}":{"get":{"tags":["Greetings"],"summary":"Get a Greeting with the given GreetingId","description":"","operationId":"getGreeting","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreeting"},"put":{"tags":["Greetings"],"summary":"Updates the Greeting with the given GreetingId","description":"","operationId":"putGreeting","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated Greeting","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putGreeting"},"delete":{"tags":["Greetings"],"summary":"Deletes a Greeting with the given GreetingId","description":"","operationId":"deleteGreeting","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"deleteGreeting"}},"/api/v2/groups/{groupId}/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Grabs the list of Default Greetings given a Group's ID","description":"","operationId":"getGroupGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGroupGreetingsDefaults"},"put":{"tags":["Greetings"],"summary":"Updates the DefaultGreetingList of the specified Group","description":"","operationId":"putGroupGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putGroupGreetingsDefaults"}},"/api/v2/groups/{groupId}/greetings":{"get":{"tags":["Greetings"],"summary":"Get a list of the Group's Greetings","description":"","operationId":"getGroupGreetings","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GreetingListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGroupGreetings"},"post":{"tags":["Greetings"],"summary":"Creates a Greeting for a Group","description":"","operationId":"postGroupGreetings","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"postGroupGreetings"}},"/api/v2/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Get an Organization's DefaultGreetingList","description":"","operationId":"getGreetingsDefaults","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreetingsDefaults"},"put":{"tags":["Greetings"],"summary":"Update an Organization's DefaultGreetingList","description":"","operationId":"putGreetingsDefaults","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putGreetingsDefaults"}},"/api/v2/greetings":{"get":{"tags":["Greetings"],"summary":"Gets an Organization's Greetings","description":"","operationId":"getGreetings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreetings"},"post":{"tags":["Greetings"],"summary":"Create a Greeting for an Organization","description":"","operationId":"postGreetings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"postGreetings"}},"/api/v2/users/{userId}/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Grabs the list of Default Greetings given a User's ID","description":"","operationId":"getUserGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getUserGreetingsDefaults"},"put":{"tags":["Greetings"],"summary":"Updates the DefaultGreetingList of the specified User","description":"","operationId":"putUserGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putUserGreetingsDefaults"}},"/api/v2/users/{userId}/greetings":{"get":{"tags":["Greetings"],"summary":"Get a list of the User's Greetings","description":"","operationId":"getUserGreetings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getUserGreetings"},"post":{"tags":["Greetings"],"summary":"Creates a Greeting for a User","description":"","operationId":"postUserGreetings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"postUserGreetings"}},"/api/v2/integrations/clientapps":{"get":{"tags":["Integrations"],"summary":"List permitted client app integrations for the logged in user","description":"","operationId":"getIntegrationsClientapps","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClientAppEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsClientapps"}},"/api/v2/integrations/{integrationId}/config/current":{"get":{"tags":["Integrations"],"summary":"Get integration configuration.","description":"","operationId":"getIntegrationConfigCurrent","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationConfigCurrent"},"put":{"tags":["Integrations"],"summary":"Update integration configuration.","description":"","operationId":"putIntegrationConfigCurrent","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Integration Configuration","required":false,"schema":{"$ref":"#/definitions/IntegrationConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.conflict":"Integration configuration update failed due to version conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:edit"]},"x-purecloud-method-name":"putIntegrationConfigCurrent"}},"/api/v2/integrations/{integrationId}":{"get":{"tags":["Integrations"],"summary":"Get integration.","description":"","operationId":"getIntegration","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegration"},"delete":{"tags":["Integrations"],"summary":"Delete integration.","description":"","operationId":"deleteIntegration","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:delete"]},"x-purecloud-method-name":"deleteIntegration"},"patch":{"tags":["Integrations"],"summary":"Update an integration.","description":"","operationId":"patchIntegration","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Integration Update","required":false,"schema":{"$ref":"#/definitions/Integration"}},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:edit"]},"x-purecloud-method-name":"patchIntegration"}},"/api/v2/integrations/types/{typeId}/configschemas/{configType}":{"get":{"tags":["Integrations"],"summary":"Get properties config schema for an integration type.","description":"","operationId":"getIntegrationsTypeConfigschema","produces":["application/json"],"parameters":[{"name":"typeId","in":"path","description":"Integration Type Id","required":true,"type":"string"},{"name":"configType","in":"path","description":"Config schema type","required":true,"type":"string","enum":["properties","advanced"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSchemaDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsTypeConfigschema"}},"/api/v2/integrations/types/{typeId}":{"get":{"tags":["Integrations"],"summary":"Get integration type.","description":"","operationId":"getIntegrationsType","produces":["application/json"],"parameters":[{"name":"typeId","in":"path","description":"Integration Type Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsType"}},"/api/v2/integrations/types":{"get":{"tags":["Integrations"],"summary":"List integration types","description":"","operationId":"getIntegrationsTypes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationTypeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsTypes"}},"/api/v2/integrations":{"get":{"tags":["Integrations"],"summary":"List integrations","description":"","operationId":"getIntegrations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrations"},"post":{"tags":["Integrations"],"summary":"Create an integration.","description":"","operationId":"postIntegrations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Integration","required":false,"schema":{"$ref":"#/definitions/CreateIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","max.integrations.reached":"The maximum number of integrations for this type have already been created. One or more integrations must be removed before a new one can be created."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:add"]},"x-purecloud-method-name":"postIntegrations"}},"/api/v2/integrations/userapps":{"get":{"tags":["Integrations"],"summary":"List permitted user app integrations for the logged in user","description":"","operationId":"getIntegrationsUserapps","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"appHost","in":"query","description":"The type of UserApp to filter by","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAppEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsUserapps"}},"/api/v2/integrations/actions/categories":{"get":{"tags":["Integrations"],"summary":"Retrieves all categories of available Actions","description":"","operationId":"getIntegrationsActionsCategories","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Root level field name to sort on. Only 'name' is supported on this endpoint.","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Direction to sort 'sortBy' field.","required":false,"type":"string","default":"asc","enum":["ASC","DESC"]},{"name":"secure","in":"query","description":"Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.","required":false,"type":"string","enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionsCategories"}},"/api/v2/integrations/actions/certificates":{"get":{"tags":["Integrations"],"summary":"Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress.","description":"","operationId":"getIntegrationsActionsCertificates","produces":["application/json"],"parameters":[{"name":"status","in":"query","description":"Indicates the validity of the certificate in question.","required":false,"type":"string","enum":["Current","Upcoming"]},{"name":"type","in":"query","description":"Indicates the type of the certificate.","required":false,"type":"string","enum":["Client"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionCertificateListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:actionCertificate:view"]},"x-purecloud-method-name":"getIntegrationsActionsCertificates"}},"/api/v2/integrations/actions/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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":{"get":{"tags":["Integrations"],"summary":"Retrieve a Draft","description":"","operationId":"getIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"expand","in":"query","description":"Indicates a field in the response which should be expanded.","required":false,"type":"string","enum":["contract"]},{"name":"includeConfig","in":"query","description":"Return config in response.","required":false,"type":"boolean","default":false,"enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionDraft"},"post":{"tags":["Integrations"],"summary":"Create a new Draft from existing Action","description":"","operationId":"postIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","policy.violation":"A policy violation occurred creating the new draft.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"postIntegrationsActionDraft"},"delete":{"tags":["Integrations"],"summary":"Delete a Draft","description":"","operationId":"deleteIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"204":{"description":"Delete was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:delete"]},"x-purecloud-method-name":"deleteIntegrationsActionDraft"},"patch":{"tags":["Integrations"],"summary":"Update an existing Draft","description":"","operationId":"patchIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to patch the Action Draft.","required":true,"schema":{"$ref":"#/definitions/UpdateDraftInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"patchIntegrationsActionDraft"}},"/api/v2/integrations/actions/{actionId}/draft/test":{"post":{"tags":["Integrations"],"summary":"Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.","description":"","operationId":"postIntegrationsActionDraftTest","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Map of parameters used for variable substitution.","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:execute"]},"x-purecloud-method-name":"postIntegrationsActionDraftTest"}},"/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve schema for a Draft based on filename.","description":"","operationId":"getIntegrationsActionDraftSchema","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of schema file to be retrieved for this draft.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSchemaDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionDraftSchema"}},"/api/v2/integrations/actions/{actionId}/draft/templates/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve templates for a Draft based on filename.","description":"","operationId":"getIntegrationsActionDraftTemplate","produces":["text/plain"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of template file to be retrieved for this action draft.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionDraftTemplate"}},"/api/v2/integrations/actions/{actionId}/draft/publish":{"post":{"tags":["Integrations"],"summary":"Publish a Draft and make it the active Action configuration","description":"","operationId":"postIntegrationsActionDraftPublish","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to patch the Action.","required":true,"schema":{"$ref":"#/definitions/PublishDraftInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"postIntegrationsActionDraftPublish"}},"/api/v2/integrations/actions/{actionId}/draft/validation":{"get":{"tags":["Integrations"],"summary":"Validate current Draft configuration.","description":"","operationId":"getIntegrationsActionDraftValidation","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DraftValidationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"getIntegrationsActionDraftValidation"}},"/api/v2/integrations/actions/{actionId}/execute":{"post":{"tags":["Integrations"],"summary":"Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.","description":"","operationId":"postIntegrationsActionExecute","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Map of parameters used for variable substitution.","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.results":"Too many results matched criteria.","bad.request":"The 3rd party indicated an issue with the request","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.schema":"There was an issue validating the schema.","constraint.validation":"%s","invalid.substitution":"There was an issue substituting a value in one of the templates","no.results":"No results were found.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.credentials":"There was an issue validating the credentials.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","bad.request":"The request is badly formed.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"method not allowed":"The request method is not allowed for this resource"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.substitution":"There was an issue substituting a value in one of the templates","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:execute","bridge:actions:execute"]},"x-purecloud-method-name":"postIntegrationsActionExecute"}},"/api/v2/integrations/actions/{actionId}":{"get":{"tags":["Integrations"],"summary":"Retrieves a single Action matching id.","description":"","operationId":"getIntegrationsAction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"expand","in":"query","description":"Indicates a field in the response which should be expanded.","required":false,"type":"string","enum":["contract"]},{"name":"includeConfig","in":"query","description":"Return config in response.","required":false,"type":"boolean","default":false,"enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsAction"},"delete":{"tags":["Integrations"],"summary":"Delete an Action","description":"","operationId":"deleteIntegrationsAction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"204":{"description":"Delete was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:delete"]},"x-purecloud-method-name":"deleteIntegrationsAction"},"patch":{"tags":["Integrations"],"summary":"Patch an Action","description":"","operationId":"patchIntegrationsAction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to patch the Action.","required":true,"schema":{"$ref":"#/definitions/UpdateActionInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"patchIntegrationsAction"}},"/api/v2/integrations/actions/{actionId}/test":{"post":{"tags":["Integrations"],"summary":"Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.","description":"","operationId":"postIntegrationsActionTest","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Map of parameters used for variable substitution.","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:execute","bridge:actions:execute"]},"x-purecloud-method-name":"postIntegrationsActionTest"}},"/api/v2/integrations/actions/{actionId}/schemas/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve schema for an action based on filename.","description":"","operationId":"getIntegrationsActionSchema","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of schema file to be retrieved for this action.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSchemaDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionSchema"}},"/api/v2/integrations/actions/{actionId}/templates/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve text of templates for an action based on filename.","description":"","operationId":"getIntegrationsActionTemplate","produces":["text/plain"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of template file to be retrieved for this action.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionTemplate"}},"/api/v2/integrations/actions/drafts":{"get":{"tags":["Integrations"],"summary":"Retrieves all action drafts associated with the filters passed in via query param.","description":"","operationId":"getIntegrationsActionsDrafts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Root level field name to sort on.","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Direction to sort 'sortBy' field.","required":false,"type":"string","default":"asc","enum":["ASC","DESC"]},{"name":"category","in":"query","description":"Filter by category name.","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter by partial or complete action name.","required":false,"type":"string"},{"name":"ids","in":"query","description":"Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.","required":false,"type":"string"},{"name":"secure","in":"query","description":"Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.","required":false,"type":"string","enum":["true","false"]},{"name":"includeAuthActions","in":"query","description":"Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.","required":false,"type":"string","default":"false","enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionsDrafts"},"post":{"tags":["Integrations"],"summary":"Create a new Draft","description":"","operationId":"postIntegrationsActionsDrafts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Input used to create Action Draft.","required":true,"schema":{"$ref":"#/definitions/PostActionInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:add"]},"x-purecloud-method-name":"postIntegrationsActionsDrafts"}},"/api/v2/integrations/actions":{"get":{"tags":["Integrations"],"summary":"Retrieves all actions associated with filters passed in via query param.","description":"","operationId":"getIntegrationsActions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Root level field name to sort on.","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Direction to sort 'sortBy' field.","required":false,"type":"string","default":"asc","enum":["ASC","DESC"]},{"name":"category","in":"query","description":"Filter by category name.","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter by partial or complete action name.","required":false,"type":"string"},{"name":"ids","in":"query","description":"Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.","required":false,"type":"string"},{"name":"secure","in":"query","description":"Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.","required":false,"type":"string","enum":["true","false"]},{"name":"includeAuthActions","in":"query","description":"Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.","required":false,"type":"string","default":"false","enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActions"},"post":{"tags":["Integrations"],"summary":"Create a new Action. Not supported for 'Function Integration' actions. Function integrations must be created as drafts to allow managing of uploading required ZIP function package before they may be used as a published action.","description":"","operationId":"postIntegrationsActions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Input used to create Action.","required":true,"schema":{"$ref":"#/definitions/PostActionInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.schema":"There is an error preventing a file from being read","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:add"]},"x-purecloud-method-name":"postIntegrationsActions"}},"/api/v2/integrations/botconnector/{integrationId}/bots":{"get":{"tags":["Integrations"],"summary":"Get a list of botConnector bots for this integration","description":"","operationId":"getIntegrationsBotconnectorIntegrationIdBots","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.unsupported.integration.type":"The integration type is unsupported or not recognized","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","bots.access.denied":"User doesn't have access to bot","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots","textbots:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:botconnector:view"]},"x-purecloud-method-name":"getIntegrationsBotconnectorIntegrationIdBots"},"put":{"tags":["Integrations"],"summary":"Set a list of botConnector bots plus versions for this integration","description":"","operationId":"putIntegrationsBotconnectorIntegrationIdBots","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"in":"body","name":"botList","required":true,"schema":{"$ref":"#/definitions/BotList"}}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.unsupported.integration.type":"The integration type is unsupported or not recognized","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","bots.access.denied":"User doesn't have access to bot","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:botconnector:edit"]},"x-purecloud-method-name":"putIntegrationsBotconnectorIntegrationIdBots"}},"/api/v2/integrations/botconnector/{integrationId}/bots/{botId}":{"get":{"tags":["Integrations"],"summary":"Get a specific botConnector bot, plus versions, for this integration","description":"","operationId":"getIntegrationsBotconnectorIntegrationIdBot","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"botId","in":"path","description":"The botID for this bot","required":true,"type":"string"},{"name":"version","in":"query","description":"Specific Version","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotConnectorBot"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.unsupported.integration.type":"The integration type is unsupported or not recognized","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","bots.access.denied":"User doesn't have access to bot","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots","textbots:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:botconnector:view"]},"x-purecloud-method-name":"getIntegrationsBotconnectorIntegrationIdBot"}},"/api/v2/integrations/botconnector/{integrationId}/bots/summaries":{"get":{"tags":["Integrations"],"summary":"Get a summary list of botConnector bots for this integration","description":"","operationId":"getIntegrationsBotconnectorIntegrationIdBotsSummaries","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotConnectorBotSummaryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.unsupported.integration.type":"The integration type is unsupported or not recognized","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","bots.access.denied":"User doesn't have access to bot","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots","textbots:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:botconnector:view"]},"x-purecloud-method-name":"getIntegrationsBotconnectorIntegrationIdBotsSummaries"}},"/api/v2/integrations/botconnector/{integrationId}/bots/{botId}/versions":{"get":{"tags":["Integrations"],"summary":"Get a list of bot versions for a bot","description":"","operationId":"getIntegrationsBotconnectorIntegrationIdBotVersions","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"The integration ID for this bot group","required":true,"type":"string"},{"name":"botId","in":"path","description":"The botID for this bot","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotConnectorBotVersionSummaryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.bot.doesnt.exist":"This occurs if the service doesn't recognize the bot that the integration code specifies","bots.unsupported.integration.type":"The integration type is unsupported or not recognized","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots","textbots:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:botconnector:view"]},"x-purecloud-method-name":"getIntegrationsBotconnectorIntegrationIdBotVersions"}},"/api/v2/integrations/speech/dialogflow/agents/{agentId}":{"get":{"tags":["Integrations"],"summary":"Get details about a Dialogflow agent","description":"","operationId":"getIntegrationsSpeechDialogflowAgent","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The agent ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialogflowAgent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechDialogflowAgent"}},"/api/v2/integrations/speech/dialogflow/agents":{"get":{"tags":["Integrations"],"summary":"Get a list of Dialogflow agents in the customers' Google accounts","description":"","operationId":"getIntegrationsSpeechDialogflowAgents","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on agent name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialogflowAgentSummaryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","general.forbidden":"Unauthorized to access of dialog flow agents.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechDialogflowAgents"}},"/api/v2/integrations/speech/dialogflowcx/agents/{agentId}":{"get":{"tags":["Integrations"],"summary":"Get details about a Dialogflow CX agent","description":"","operationId":"getIntegrationsSpeechDialogflowcxAgent","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The agent ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialogflowCXAgent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechDialogflowcxAgent"}},"/api/v2/integrations/speech/dialogflowcx/agents":{"get":{"tags":["Integrations"],"summary":"Get a list of Dialogflow CX agents in the customers' Google accounts","description":"","operationId":"getIntegrationsSpeechDialogflowcxAgents","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on agent name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialogflowCXAgentSummaryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","general.forbidden":"Unauthorized to access of dialog flow cx agents.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechDialogflowcxAgents"}},"/api/v2/integrations/speech/lex/bot/alias/{aliasId}":{"get":{"tags":["Integrations"],"summary":"Get details about a Lex bot alias","description":"","operationId":"getIntegrationsSpeechLexBotAlias","produces":["application/json"],"parameters":[{"name":"aliasId","in":"path","description":"The alias ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexBotAlias"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request is badly formed","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexBotAlias"}},"/api/v2/integrations/speech/lex/bot/{botId}/aliases":{"get":{"tags":["Integrations"],"summary":"Get a list of aliases for a bot in the customer's AWS accounts","description":"","operationId":"getIntegrationsSpeechLexBotBotIdAliases","produces":["application/json"],"parameters":[{"name":"botId","in":"path","description":"The bot ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"status","in":"query","description":"Filter on alias status","required":false,"type":"string","enum":["READY","FAILED","BUILDING","NOT_BUILT"]},{"name":"name","in":"query","description":"Filter on alias name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexBotAliasEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexBotBotIdAliases"}},"/api/v2/integrations/speech/lex/bots":{"get":{"tags":["Integrations"],"summary":"Get a list of Lex bots in the customers' AWS accounts","description":"","operationId":"getIntegrationsSpeechLexBots","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on bot name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexBotEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexBots"}},"/api/v2/integrations/speech/lexv2/bot/alias/{aliasId}":{"get":{"tags":["Integrations"],"summary":"Get details about a Lex V2 bot alias","description":"","operationId":"getIntegrationsSpeechLexv2BotAlias","produces":["application/json"],"parameters":[{"name":"aliasId","in":"path","description":"The Alias ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexV2BotAlias"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request is badly formed","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexv2BotAlias"}},"/api/v2/integrations/speech/lexv2/bot/{botId}/aliases":{"get":{"tags":["Integrations"],"summary":"Get a list of aliases for a Lex V2 bot","description":"","operationId":"getIntegrationsSpeechLexv2BotBotIdAliases","produces":["application/json"],"parameters":[{"name":"botId","in":"path","description":"The Bot ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"status","in":"query","description":"Filter on alias status","required":false,"type":"string","enum":["Creating","Available","Deleting","Failed"]},{"name":"name","in":"query","description":"Filter on alias name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexV2BotAliasEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexv2BotBotIdAliases"}},"/api/v2/integrations/speech/lexv2/bots":{"get":{"tags":["Integrations"],"summary":"Get a list of Lex V2 bots","description":"","operationId":"getIntegrationsSpeechLexv2Bots","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on bot name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexV2BotEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexv2Bots"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs/{jobId}":{"get":{"tags":["Integrations"],"summary":"Get the status of an asynchronous Nuance bot GET job","description":"","operationId":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"botId","in":"path","description":"The Nuance bot ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"The asynchronous job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs/{jobId}/results":{"get":{"tags":["Integrations"],"summary":"Get the result of an asynchronous Nuance bot GET job","description":"","operationId":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"botId","in":"path","description":"The Nuance bot ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"The asynchronous job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NuanceBot"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The asynchronous operation is still in the 'running' state."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs":{"post":{"tags":["Integrations"],"summary":"Get a Nuance bot in the specified Integration asynchronously","description":"","operationId":"postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"botId","in":"path","description":"The Nuance bot ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string","enum":["variables","transferNodes","channels","locales"]},"collectionFormat":"multi"},{"in":"body","name":"body","description":"targetChannel","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncJob"}},"202":{"description":"Job created","schema":{"$ref":"#/definitions/AsyncJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}":{"get":{"tags":["Integrations"],"summary":"Get a Nuance bot in the specified Integration","description":"","operationId":"getIntegrationsSpeechNuanceNuanceIntegrationIdBot","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"botId","in":"path","description":"The Nuance bot ID to get","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string","enum":["variables","transferNodes","channels","locales"]},"collectionFormat":"multi"},{"name":"targetChannel","in":"query","description":"targetChannel","required":false,"type":"string","enum":["digital","voice"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NuanceBot"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechNuanceNuanceIntegrationIdBot"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs/{jobId}":{"get":{"tags":["Integrations"],"summary":"Get the status of an asynchronous Nuance bots GET job","description":"","operationId":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"jobId","in":"path","description":"The asynchronous job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs/{jobId}/results":{"get":{"tags":["Integrations"],"summary":"Get the result of an asynchronous Nuance bots GET job","description":"","operationId":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"jobId","in":"path","description":"The asynchronous job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NuanceBotEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The asynchronous operation is still in the 'running' state."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs":{"post":{"tags":["Integrations"],"summary":"Get a list of Nuance bots in the specified Integration asynchronously","description":"","operationId":"postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"onlyRegisteredBots","in":"query","description":"Limit bots to the ones configured for Genesys Cloud usage","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncJob"}},"202":{"description":"Job created","schema":{"$ref":"#/definitions/AsyncJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/settings":{"put":{"tags":["Integrations"],"summary":"Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration","description":"","operationId":"putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"in":"body","name":"settings","required":true,"schema":{"$ref":"#/definitions/NuanceBotLaunchSettings"}}],"responses":{"204":{"description":"Configuration updated"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:edit"]},"x-purecloud-method-name":"putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/validate":{"post":{"tags":["Integrations"],"summary":"Try out a single credential for a Nuance bot to know if the secret is correct","description":"","operationId":"postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"in":"body","name":"settings","required":true,"schema":{"$ref":"#/definitions/BotExecutionConfiguration"}}],"responses":{"204":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:edit"]},"x-purecloud-method-name":"postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots":{"get":{"tags":["Integrations"],"summary":"Get a list of Nuance bots available in the specified Integration","description":"If the 'onlyRegisteredBots' param is set, the returned data will only include the Nuance bots which have configured client secrets within the Integration, otherwise all of the Nuance bots available to the Integration's configured discovery credentials are returned.","operationId":"getIntegrationsSpeechNuanceNuanceIntegrationIdBots","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"onlyRegisteredBots","in":"query","description":"Limit bots to the ones configured for Genesys Cloud usage","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NuanceBotEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechNuanceNuanceIntegrationIdBots"}},"/api/v2/integrations/speech/stt/engines/{engineId}":{"get":{"tags":["Integrations"],"summary":"Get details about a STT engine","description":"","operationId":"getIntegrationsSpeechSttEngine","produces":["application/json"],"parameters":[{"name":"engineId","in":"path","description":"The engine ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SttEngineEntity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechSttEngine"}},"/api/v2/integrations/speech/stt/engines":{"get":{"tags":["Integrations"],"summary":"Get a list of STT engines enabled for org","description":"","operationId":"getIntegrationsSpeechSttEngines","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on engine name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SttEngineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechSttEngines"}},"/api/v2/integrations/speech/tts/engines/{engineId}":{"get":{"tags":["Integrations"],"summary":"Get details about a TTS engine","description":"","operationId":"getIntegrationsSpeechTtsEngine","produces":["application/json"],"parameters":[{"name":"engineId","in":"path","description":"The engine ID","required":true,"type":"string"},{"name":"includeVoices","in":"query","description":"Include voices for the engine","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsEngineEntity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngine"}},"/api/v2/integrations/speech/tts/engines":{"get":{"tags":["Integrations"],"summary":"Get a list of TTS engines enabled for org","description":"","operationId":"getIntegrationsSpeechTtsEngines","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"includeVoices","in":"query","description":"Include voices for the engine","required":false,"type":"boolean","default":false},{"name":"name","in":"query","description":"Filter on engine name","required":false,"type":"string"},{"name":"language","in":"query","description":"Filter on supported language. If includeVoices=true then the voices are also filtered.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsEngineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngines"}},"/api/v2/integrations/speech/tts/settings":{"get":{"tags":["Integrations"],"summary":"Get TTS settings for an org","description":"","operationId":"getIntegrationsSpeechTtsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsSettings"},"put":{"tags":["Integrations"],"summary":"Update TTS settings for an org","description":"","operationId":"putIntegrationsSpeechTtsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Updated TtsSettings","required":true,"schema":{"$ref":"#/definitions/TtsSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:edit"]},"x-purecloud-method-name":"putIntegrationsSpeechTtsSettings"}},"/api/v2/integrations/speech/tts/engines/{engineId}/voices/{voiceId}":{"get":{"tags":["Integrations"],"summary":"Get details about a specific voice for a TTS engine","description":"","operationId":"getIntegrationsSpeechTtsEngineVoice","produces":["application/json"],"parameters":[{"name":"engineId","in":"path","description":"The engine ID","required":true,"type":"string"},{"name":"voiceId","in":"path","description":"The voice ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsVoiceEntity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngineVoice"}},"/api/v2/integrations/speech/tts/engines/{engineId}/voices":{"get":{"tags":["Integrations"],"summary":"Get a list of voices for a TTS engine","description":"","operationId":"getIntegrationsSpeechTtsEngineVoices","produces":["application/json"],"parameters":[{"name":"engineId","in":"path","description":"The engine ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsVoiceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngineVoices"}},"/api/v2/journey/actionmaps/{actionMapId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single action map.","description":"","operationId":"getJourneyActionmap","produces":["application/json"],"parameters":[{"name":"actionMapId","in":"path","description":"ID of the action map.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMap"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:view"]},"x-purecloud-method-name":"getJourneyActionmap"},"delete":{"tags":["Journey"],"summary":"Delete single action map.","description":"","operationId":"deleteJourneyActionmap","produces":["application/json"],"parameters":[{"name":"actionMapId","in":"path","description":"ID of the action map.","required":true,"type":"string"}],"responses":{"204":{"description":"Action map deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:delete"]},"x-purecloud-method-name":"deleteJourneyActionmap"},"patch":{"tags":["Journey"],"summary":"Update single action map.","description":"","operationId":"patchJourneyActionmap","produces":["application/json"],"parameters":[{"name":"actionMapId","in":"path","description":"ID of the action map.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchActionMap"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMap"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:edit"]},"x-purecloud-method-name":"patchJourneyActionmap"}},"/api/v2/journey/actionmaps":{"get":{"tags":["Journey"],"summary":"Retrieve all action maps.","description":"","operationId":"getJourneyActionmaps","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).","required":false,"type":"string"},{"name":"filterField","in":"query","description":"Field to filter by (e.g. filterField=weight or filterField=action.actionTemplate.id). Requires 'filterField' to also be set.","required":false,"type":"string"},{"name":"filterValue","in":"query","description":"Value to filter by. Requires 'filterValue' to also be set.","required":false,"type":"string"},{"name":"actionMapIds","in":"query","description":"IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryFields","in":"query","description":"Action Map field(s) to query on. Requires 'queryValue' to also be set.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryValue","in":"query","description":"Value to query on. Requires 'queryFields' to also be set.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMapListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:view"]},"x-purecloud-method-name":"getJourneyActionmaps"},"post":{"tags":["Journey"],"summary":"Create an action map.","description":"","operationId":"postJourneyActionmaps","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ActionMap"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMap"}},"201":{"description":"Action map created.","schema":{"$ref":"#/definitions/ActionMap"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:add"]},"x-purecloud-method-name":"postJourneyActionmaps"}},"/api/v2/journey/actiontargets/{actionTargetId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single action target.","description":"","operationId":"getJourneyActiontarget","produces":["application/json"],"parameters":[{"name":"actionTargetId","in":"path","description":"ID of the action target.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTarget"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontarget:view"]},"x-purecloud-method-name":"getJourneyActiontarget"},"patch":{"tags":["Journey"],"summary":"Update a single action target.","description":"","operationId":"patchJourneyActiontarget","produces":["application/json"],"parameters":[{"name":"actionTargetId","in":"path","description":"ID of the action target.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchActionTarget"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTarget"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontarget:edit"]},"x-purecloud-method-name":"patchJourneyActiontarget"}},"/api/v2/journey/actiontargets":{"get":{"tags":["Journey"],"summary":"Retrieve all action targets.","description":"","operationId":"getJourneyActiontargets","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTargetListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontarget:view"]},"x-purecloud-method-name":"getJourneyActiontargets"}},"/api/v2/journey/actiontemplates/{actionTemplateId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single action template.","description":"","operationId":"getJourneyActiontemplate","produces":["application/json"],"parameters":[{"name":"actionTemplateId","in":"path","description":"ID of the action template.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:view"]},"x-purecloud-method-name":"getJourneyActiontemplate"},"delete":{"tags":["Journey"],"summary":"Delete a single action template.","description":"","operationId":"deleteJourneyActiontemplate","produces":["application/json"],"parameters":[{"name":"actionTemplateId","in":"path","description":"ID of the action template.","required":true,"type":"string"},{"name":"hardDelete","in":"query","description":"Determines whether Action Template should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default.","required":false,"type":"boolean"}],"responses":{"204":{"description":"Action template deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:delete"]},"x-purecloud-method-name":"deleteJourneyActiontemplate"},"patch":{"tags":["Journey"],"summary":"Update a single action template.","description":"","operationId":"patchJourneyActiontemplate","produces":["application/json"],"parameters":[{"name":"actionTemplateId","in":"path","description":"ID of the action template.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchActionTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:edit"]},"x-purecloud-method-name":"patchJourneyActiontemplate"}},"/api/v2/journey/actiontemplates":{"get":{"tags":["Journey"],"summary":"Retrieve all action templates.","description":"","operationId":"getJourneyActiontemplates","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=name,-createdDate).","required":false,"type":"string"},{"name":"mediaType","in":"query","description":"Media type","required":false,"type":"string","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow","openAction"]},{"name":"state","in":"query","description":"Action template state.","required":false,"type":"string","enum":["Active","Inactive","Deleted"]},{"name":"queryFields","in":"query","description":"ActionTemplate field(s) to query on. Requires 'queryValue' to also be set.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryValue","in":"query","description":"Value to query on. Requires 'queryFields' to also be set.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplateListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:view"]},"x-purecloud-method-name":"getJourneyActiontemplates"},"post":{"tags":["Journey"],"summary":"Create a single action template.","description":"","operationId":"postJourneyActiontemplates","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ActionTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplate"}},"201":{"description":"Action template created.","schema":{"$ref":"#/definitions/ActionTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:add"]},"x-purecloud-method-name":"postJourneyActiontemplates"}},"/api/v2/journey/actionmaps/estimates/jobs/{jobId}":{"get":{"tags":["Journey"],"summary":"Get status of job.","description":"","operationId":"getJourneyActionmapsEstimatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"ID of the job.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["Cancelled","Failed","Queued","Running","Succeeded"]}},"202":{"description":"Accepted - Running query asynchronously","schema":{"type":"string","enum":["Cancelled","Failed","Queued","Running","Succeeded"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:actionmapEstimateJob:view"]},"x-purecloud-method-name":"getJourneyActionmapsEstimatesJob"}},"/api/v2/journey/actionmaps/estimates/jobs/{jobId}/results":{"get":{"tags":["Journey"],"summary":"Get estimates from completed job.","description":"","operationId":"getJourneyActionmapsEstimatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"ID of the job.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMapEstimateResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:actionmapEstimate:view"]},"x-purecloud-method-name":"getJourneyActionmapsEstimatesJobResults"}},"/api/v2/journey/actionmaps/estimates/jobs":{"post":{"tags":["Journey"],"summary":"Query for estimates","description":"","operationId":"postJourneyActionmapsEstimatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"audience estimator request","required":true,"schema":{"$ref":"#/definitions/ActionMapEstimateRequest"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/EstimateJobAsyncResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmapEstimateJob:add"]},"x-purecloud-method-name":"postJourneyActionmapsEstimatesJobs"}},"/api/v2/journey/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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:flowpaths:view"]},"x-purecloud-method-name":"postJourneyFlowsPathsQuery"}},"/api/v2/journey/outcomes/{outcomeId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single outcome.","description":"","operationId":"getJourneyOutcome","produces":["application/json"],"parameters":[{"name":"outcomeId","in":"path","description":"ID of the outcome.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Outcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:view"]},"x-purecloud-method-name":"getJourneyOutcome"},"delete":{"tags":["Journey"],"summary":"Delete an outcome.","description":"","operationId":"deleteJourneyOutcome","produces":["application/json"],"parameters":[{"name":"outcomeId","in":"path","description":"ID of the outcome.","required":true,"type":"string"}],"responses":{"204":{"description":"Outcome deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:delete"]},"x-purecloud-method-name":"deleteJourneyOutcome"},"patch":{"tags":["Journey"],"summary":"Update an outcome.","description":"","operationId":"patchJourneyOutcome","produces":["application/json"],"parameters":[{"name":"outcomeId","in":"path","description":"ID of the outcome.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchOutcome"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Outcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:edit"]},"x-purecloud-method-name":"patchJourneyOutcome"}},"/api/v2/journey/outcomes":{"get":{"tags":["Journey"],"summary":"Retrieve all outcomes.","description":"","operationId":"getJourneyOutcomes","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).","required":false,"type":"string"},{"name":"outcomeIds","in":"query","description":"IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryFields","in":"query","description":"Outcome field(s) to query on. Requires 'queryValue' to also be set.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryValue","in":"query","description":"Value to query on. Requires 'queryFields' to also be set.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:view"]},"x-purecloud-method-name":"getJourneyOutcomes"},"post":{"tags":["Journey"],"summary":"Create an outcome.","description":"","operationId":"postJourneyOutcomes","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/OutcomeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Outcome"}},"201":{"description":"Outcome created.","schema":{"$ref":"#/definitions/Outcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:add"]},"x-purecloud-method-name":"postJourneyOutcomes"}},"/api/v2/journey/sessions/{sessionId}/outcomescores":{"get":{"tags":["Journey"],"summary":"Retrieve latest outcome score associated with a session for all outcomes.","description":"","operationId":"getJourneySessionOutcomescores","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"ID of the session.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomeScoresResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcomescores:view"]},"x-purecloud-method-name":"getJourneySessionOutcomescores"}},"/api/v2/journey/outcomes/predictors/{predictorId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single outcome predictor.","description":"","operationId":"getJourneyOutcomesPredictor","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"ID of predictor","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomePredictor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcomepredictor:view"]},"x-purecloud-method-name":"getJourneyOutcomesPredictor"},"delete":{"tags":["Journey"],"summary":"Delete an outcome predictor.","description":"","operationId":"deleteJourneyOutcomesPredictor","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"ID of predictor","required":true,"type":"string"}],"responses":{"204":{"description":"Predictor deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcomepredictor:delete"]},"x-purecloud-method-name":"deleteJourneyOutcomesPredictor"}},"/api/v2/journey/outcomes/predictors":{"get":{"tags":["Journey"],"summary":"Retrieve all outcome predictors.","description":"","operationId":"getJourneyOutcomesPredictors","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomePredictorListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcomepredictor:view"]},"x-purecloud-method-name":"getJourneyOutcomesPredictors"},"post":{"tags":["Journey"],"summary":"Create an outcome predictor.","description":"","operationId":"postJourneyOutcomesPredictors","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/OutcomePredictorRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomePredictor"}},"201":{"description":"Predictor created.","schema":{"$ref":"#/definitions/OutcomePredictor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcomepredictor:add"]},"x-purecloud-method-name":"postJourneyOutcomesPredictors"}},"/api/v2/journey/segments/{segmentId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single segment.","description":"","operationId":"getJourneySegment","produces":["application/json"],"parameters":[{"name":"segmentId","in":"path","description":"ID of the segment.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneySegment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:view"]},"x-purecloud-method-name":"getJourneySegment"},"delete":{"tags":["Journey"],"summary":"Delete a segment.","description":"","operationId":"deleteJourneySegment","produces":["application/json"],"parameters":[{"name":"segmentId","in":"path","description":"ID of the segment.","required":true,"type":"string"}],"responses":{"204":{"description":"Segment deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:delete"]},"x-purecloud-method-name":"deleteJourneySegment"},"patch":{"tags":["Journey"],"summary":"Update a segment.","description":"","operationId":"patchJourneySegment","produces":["application/json"],"parameters":[{"name":"segmentId","in":"path","description":"ID of the segment.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchSegment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneySegment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:edit"]},"x-purecloud-method-name":"patchJourneySegment"}},"/api/v2/journey/segments":{"get":{"tags":["Journey"],"summary":"Retrieve all segments.","description":"","operationId":"getJourneySegments","produces":["application/json"],"parameters":[{"name":"sortBy","in":"query","description":"Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"isActive","in":"query","description":"Determines whether or not to show only active segments.","required":false,"type":"boolean"},{"name":"segmentIds","in":"query","description":"IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryFields","in":"query","description":"Segment field(s) to query on. Requires 'queryValue' to also be set.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryValue","in":"query","description":"Value to query on. Requires 'queryFields' to also be set.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SegmentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:view"]},"x-purecloud-method-name":"getJourneySegments"},"post":{"tags":["Journey"],"summary":"Create a segment.","description":"","operationId":"postJourneySegments","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JourneySegmentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneySegment"}},"201":{"description":"Segment created.","schema":{"$ref":"#/definitions/JourneySegment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:add"]},"x-purecloud-method-name":"postJourneySegments"}},"/api/v2/journey/sessions/{sessionId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single session.","description":"","operationId":"getJourneySession","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"ID of the session.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Session"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:session:view","externalContacts:session:view"]},"x-purecloud-method-name":"getJourneySession"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories":{"get":{"tags":["Knowledge"],"summary":"Get categories","description":"","operationId":"getKnowledgeKnowledgebaseCategories","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"parentId","in":"query","description":"If specified, retrieves the children categories by parent category ID.","required":false,"type":"string"},{"name":"isRoot","in":"query","description":"If specified, retrieves only the root categories.","required":false,"type":"boolean"},{"name":"name","in":"query","description":"Filter to return the categories that starts with the given category name.","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically","required":false,"type":"string","default":"Name","enum":["Name","Hierarchy"]},{"name":"expand","in":"query","description":"The specified entity attribute will be filled. Supported value:\"Ancestors\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors.","required":false,"type":"string"},{"name":"includeDocumentCount","in":"query","description":"If specified, retrieves the number of documents related to category.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseCategories"},"post":{"tags":["Knowledge"],"summary":"Create new category","description":"","operationId":"postKnowledgeKnowledgebaseCategories","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CategoryCreateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryResponse"}},"201":{"description":"Category created","schema":{"$ref":"#/definitions/CategoryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","limit.reached":"Total number, maximum child or maximum depth limit has been reached."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"already.exists":"Category with same name already exists"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseCategories"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}":{"get":{"tags":["Knowledge"],"summary":"Get category","description":"","operationId":"getKnowledgeKnowledgebaseCategory","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseCategory"},"delete":{"tags":["Knowledge"],"summary":"Delete category","description":"","operationId":"deleteKnowledgeKnowledgebaseCategory","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryResponse"}},"204":{"description":"Category deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","constraint.validation":"Input parameters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseCategory"},"patch":{"tags":["Knowledge"],"summary":"Update category","description":"","operationId":"patchKnowledgeKnowledgebaseCategory","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CategoryUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.parent.category":"Subcategory cannot be the parent category.","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","limit.reached":"Maximum child or maximum depth limit has been reached."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"already.exists":"Category with same name already exists"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseCategory"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search":{"post":{"tags":["Knowledge","Search"],"summary":"Search Documents","description":"","operationId":"postKnowledgeKnowledgebaseSearch","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","min.length.expected":"The minimum characters for the query is 5","invalid.languagecode":"Language code must be of format lang-iso2 (eg: en-US)","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:search"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseSearch"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories":{"get":{"tags":["Knowledge"],"summary":"Get categories","description":"","operationId":"getKnowledgeKnowledgebaseLanguageCategories","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter to return the categories that starts with the given category name.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageCategories"},"post":{"tags":["Knowledge"],"summary":"Create new category","description":"","operationId":"postKnowledgeKnowledgebaseLanguageCategories","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeCategoryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExtendedCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageCategories"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}":{"get":{"tags":["Knowledge"],"summary":"Get category","description":"","operationId":"getKnowledgeKnowledgebaseLanguageCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExtendedCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Resource not found","category.not.found":"Category does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageCategory"},"delete":{"tags":["Knowledge"],"summary":"Delete category","description":"","operationId":"deleteKnowledgeKnowledgebaseLanguageCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeCategory"}},"204":{"description":"Category deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Resource not found","category.not.found":"Category does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseLanguageCategory"},"patch":{"tags":["Knowledge"],"summary":"Update category","description":"","operationId":"patchKnowledgeKnowledgebaseLanguageCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeCategoryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExtendedCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"category.not.found":"Category does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLanguageCategory"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}":{"get":{"tags":["Knowledge"],"summary":"Get import operation report","description":"","operationId":"getKnowledgeKnowledgebaseLanguageDocumentsImport","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"importId","in":"path","description":"Import ID","required":true,"type":"string"}],"responses":{"200":{"description":"Finished import operation","schema":{"$ref":"#/definitions/KnowledgeImport"}},"202":{"description":"Pending import operation","schema":{"$ref":"#/definitions/KnowledgeImport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:add"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageDocumentsImport"},"delete":{"tags":["Knowledge"],"summary":"Delete import operation","description":"","operationId":"deleteKnowledgeKnowledgebaseLanguageDocumentsImport","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"importId","in":"path","description":"Import ID","required":true,"type":"string"}],"responses":{"204":{"description":"Import operation deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Import operation does exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:add"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseLanguageDocumentsImport"},"patch":{"tags":["Knowledge"],"summary":"Start import operation","description":"","operationId":"patchKnowledgeKnowledgebaseLanguageDocumentsImport","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"importId","in":"path","description":"Import ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ImportStatusRequest"}}],"responses":{"200":{"description":"Import operation finished","schema":{"$ref":"#/definitions/KnowledgeImport"}},"202":{"description":"Import operation started","schema":{"$ref":"#/definitions/KnowledgeImport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Import operation does exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit","knowledge:document:add"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLanguageDocumentsImport"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports":{"post":{"tags":["Knowledge"],"summary":"Create import operation","description":"","operationId":"postKnowledgeKnowledgebaseLanguageDocumentsImports","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeImport"}}],"responses":{"202":{"description":"Created import operation","schema":{"$ref":"#/definitions/KnowledgeImport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageDocumentsImports"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}":{"get":{"tags":["Knowledge"],"summary":"Get document","description":"","operationId":"getKnowledgeKnowledgebaseLanguageDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist","document.not.found":"Document does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageDocument"},"delete":{"tags":["Knowledge"],"summary":"Delete document","description":"","operationId":"deleteKnowledgeKnowledgebaseLanguageDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"204":{"description":"Document deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","input.validations":"Input parameters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist","document.not.found":"Document does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseLanguageDocument"},"patch":{"tags":["Knowledge"],"summary":"Update document","description":"","operationId":"patchKnowledgeKnowledgebaseLanguageDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist","document.not.found":"Document does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLanguageDocument"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents":{"get":{"tags":["Knowledge"],"summary":"Get documents","description":"","operationId":"getKnowledgeKnowledgebaseLanguageDocuments","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"categories","in":"query","description":"Filter by categories ids, comma separated values expected.","required":false,"type":"string"},{"name":"title","in":"query","description":"Filter by document title.","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by.","required":false,"type":"string","enum":["Title","Date"]},{"name":"sortOrder","in":"query","description":"Sort Order.","required":false,"type":"string","enum":["ASC","ascending","DESC","descending"]},{"name":"documentIds","in":"query","description":"Comma-separated list of document identifiers to fetch by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageDocuments"},"post":{"tags":["Knowledge"],"summary":"Create document","description":"","operationId":"postKnowledgeKnowledgebaseLanguageDocuments","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","document.limitexceeded":"Document count exceeded for kbId","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageDocuments"},"patch":{"tags":["Knowledge"],"summary":"Update documents collection","description":"","operationId":"patchKnowledgeKnowledgebaseLanguageDocuments","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"in":"body","name":"body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/KnowledgeDocumentBulkRequest"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist","document.not.found":"Document does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"500":"Internal server error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLanguageDocuments"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}":{"get":{"tags":["Knowledge"],"summary":"Get knowledge base","description":"","operationId":"getKnowledgeKnowledgebase","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input paramaters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebase"},"delete":{"tags":["Knowledge"],"summary":"Delete knowledge base","description":"","operationId":"deleteKnowledgeKnowledgebase","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"204":{"description":"Knowledge base deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","input.validations":"Input paramaters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledgebase not found","not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.in.use":"knowledgebase in use by bot flow"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.bot.flow.status.unknown":"Knowledgebase bot flow status unknown"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebase"},"patch":{"tags":["Knowledge"],"summary":"Update knowledge base","description":"","operationId":"patchKnowledgeKnowledgebase","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeBaseUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input paramaters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebase"}},"/api/v2/knowledge/knowledgebases":{"get":{"tags":["Knowledge"],"summary":"Get knowledge bases","description":"","operationId":"getKnowledgeKnowledgebases","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 100. Deprecated in favour of pageSize","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 100.","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter by Name.","required":false,"type":"string"},{"name":"coreLanguage","in":"query","description":"Filter by core language.","required":false,"type":"string","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"published","in":"query","description":"Filter by published status.","required":false,"type":"boolean"},{"name":"sortBy","in":"query","description":"Sort by.","required":false,"type":"string","enum":["Name","Date"]},{"name":"sortOrder","in":"query","description":"Sort Order.","required":false,"type":"string","enum":["ASC","ascending","DESC","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBaseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebases"},"post":{"tags":["Knowledge"],"summary":"Create new knowledge base","description":"","operationId":"postKnowledgeKnowledgebases","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeBaseCreateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"kb.limitexceeded":"Knowledge Base count exceeded","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebases"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups":{"get":{"tags":["Knowledge"],"summary":"Get knowledge base unanswered groups","description":"","operationId":"getKnowledgeKnowledgebaseUnansweredGroups","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"app","in":"query","description":"The app value to be used for filtering phrases.","required":false,"type":"string","enum":["SupportCenter","MessengerKnowledgeApp","BotFlow","Assistant","SmartAdvisor"]},{"name":"dateStart","in":"query","description":"The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"dateEnd","in":"query","description":"The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnansweredGroups"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:groups:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseUnansweredGroups"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}":{"get":{"tags":["Knowledge"],"summary":"Get knowledge base unanswered group for a particular groupId","description":"","operationId":"getKnowledgeKnowledgebaseUnansweredGroup","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"groupId","in":"path","description":"The ID of the group to be retrieved.","required":true,"type":"string"},{"name":"app","in":"query","description":"The app value to be used for filtering phrases.","required":false,"type":"string","enum":["SupportCenter","MessengerKnowledgeApp","BotFlow","Assistant","SmartAdvisor"]},{"name":"dateStart","in":"query","description":"The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"dateEnd","in":"query","description":"The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnansweredGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:groups:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseUnansweredGroup"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}":{"get":{"tags":["Knowledge"],"summary":"Get knowledge base unanswered phrase group for a particular phraseGroupId","description":"","operationId":"getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"groupId","in":"path","description":"The ID of the group to be retrieved.","required":true,"type":"string"},{"name":"phraseGroupId","in":"path","description":"The ID of the phraseGroup to be retrieved.","required":true,"type":"string"},{"name":"app","in":"query","description":"The app value to be used for filtering phrases.","required":false,"type":"string","enum":["SupportCenter","MessengerKnowledgeApp","BotFlow","Assistant","SmartAdvisor"]},{"name":"dateStart","in":"query","description":"The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"dateEnd","in":"query","description":"The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnansweredPhraseGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:groups:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup"},"patch":{"tags":["Knowledge"],"summary":"Update a Knowledge base unanswered phrase group","description":"","operationId":"patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"groupId","in":"path","description":"The ID of the group to be updated.","required":true,"type":"string"},{"name":"phraseGroupId","in":"path","description":"The ID of the phraseGroup to be updated.","required":true,"type":"string"},{"in":"body","name":"body","description":"Request body of the update unanswered group endpoint.","required":true,"schema":{"$ref":"#/definitions/UnansweredPhraseGroupPatchRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnansweredPhraseGroupUpdateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:groups:edit","knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}":{"get":{"tags":["Knowledge"],"summary":"Get label","description":"","operationId":"getKnowledgeKnowledgebaseLabel","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"labelId","in":"path","description":"Label ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LabelResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:label:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLabel"},"delete":{"tags":["Knowledge"],"summary":"Delete label","description":"","operationId":"deleteKnowledgeKnowledgebaseLabel","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"labelId","in":"path","description":"Label ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LabelResponse"}},"204":{"description":"Label deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","constraint.validation":"Input parameters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:label:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseLabel"},"patch":{"tags":["Knowledge"],"summary":"Update label","description":"","operationId":"patchKnowledgeKnowledgebaseLabel","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"labelId","in":"path","description":"Label ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/LabelUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LabelResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"already.exists":"Label with the new name already exists"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:label:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLabel"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels":{"get":{"tags":["Knowledge"],"summary":"Get labels","description":"","operationId":"getKnowledgeKnowledgebaseLabels","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter to return the labels that contains the given phrase in the name.","required":false,"type":"string"},{"name":"includeDocumentCount","in":"query","description":"If specified, retrieves the number of documents related to label.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LabelListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:label:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLabels"},"post":{"tags":["Knowledge"],"summary":"Create new label","description":"","operationId":"postKnowledgeKnowledgebaseLabels","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/LabelCreateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LabelResponse"}},"201":{"description":"Label created","schema":{"$ref":"#/definitions/LabelResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","limit.reached":"The limit for the number of labels has been reached."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"already.exists":"Label with same name already exists"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:label:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLabels"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}":{"get":{"tags":["Knowledge"],"summary":"Get training detail","description":"","operationId":"getKnowledgeKnowledgebaseLanguageTraining","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"trainingId","in":"path","description":"Training ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeTraining"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageTraining"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}/promote":{"post":{"tags":["Knowledge"],"summary":"Promote trained documents from draft state to active.","description":"","operationId":"postKnowledgeKnowledgebaseLanguageTrainingPromote","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"trainingId","in":"path","description":"Training ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeTraining"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:edit"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageTrainingPromote"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings":{"get":{"tags":["Knowledge"],"summary":"Get all trainings information for a knowledgebase","description":"","operationId":"getKnowledgeKnowledgebaseLanguageTrainings","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"knowledgeDocumentsState","in":"query","description":"Return the training with the specified state of the trained documents.","required":false,"type":"string","enum":["Draft","Active","Discarded","Archived"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrainingListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageTrainings"},"post":{"tags":["Knowledge"],"summary":"Trigger training","description":"","operationId":"postKnowledgeKnowledgebaseLanguageTrainings","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeTraining"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:create"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageTrainings"}},"/api/v2/knowledge/documentuploads":{"post":{"tags":["Knowledge","Uploads"],"summary":"Creates a presigned URL for uploading a knowledge import file with a set of documents","description":"","operationId":"postKnowledgeDocumentuploads","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned URL successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:upload"]},"x-purecloud-method-name":"postKnowledgeDocumentuploads"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}":{"get":{"tags":["Knowledge"],"summary":"Get document.","description":"","operationId":"getKnowledgeKnowledgebaseDocument","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected. Max No. of variations that can be returned on expand is 20.","required":false,"type":"array","items":{"type":"string","enum":["category","labels","variations"]},"collectionFormat":"multi"},{"name":"state","in":"query","description":"\"when state is \"Draft\", draft version of the document is returned,otherwise by default published version is returned in the response.","required":false,"type":"string","enum":["Draft","Published"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocument"},"delete":{"tags":["Knowledge"],"summary":"Delete document.","description":"","operationId":"deleteKnowledgeKnowledgebaseDocument","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"}],"responses":{"204":{"description":"Document deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseDocument"},"patch":{"tags":["Knowledge"],"summary":"Update document.","description":"","operationId":"patchKnowledgeKnowledgebaseDocument","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentReq"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseDocument"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}":{"get":{"tags":["Knowledge"],"summary":"Get document version.","description":"","operationId":"getKnowledgeKnowledgebaseDocumentVersion","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Globally unique identifier for the document version.","required":true,"type":"string"},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["category","labels"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentVersion:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentVersion"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions":{"get":{"tags":["Knowledge"],"summary":"Get document versions.","description":"","operationId":"getKnowledgeKnowledgebaseDocumentVersions","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["category","labels"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentVersionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentVersion:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentVersions"},"post":{"tags":["Knowledge"],"summary":"Creates or restores a document version.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentVersions","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentVersion"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentVersion:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentVersions"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents":{"get":{"tags":["Knowledge"],"summary":"Get documents.","description":"","operationId":"getKnowledgeKnowledgebaseDocuments","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"interval","in":"query","description":"Retrieves the documents modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ","required":false,"type":"string","format":"interval"},{"name":"documentId","in":"query","description":"Retrieves the specified documents, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"categoryId","in":"query","description":"If specified, retrieves documents associated with category ids, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"includeSubcategories","in":"query","description":"Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.","required":false,"type":"boolean"},{"name":"includeDrafts","in":"query","description":"If includeDrafts is true, Documents in the draft state are also returned in the response.","required":false,"type":"boolean"},{"name":"labelIds","in":"query","description":"If specified, retrieves documents associated with label ids, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["category","labels","variations"]},"collectionFormat":"multi"},{"name":"externalIds","in":"query","description":"If specified, retrieves documents associated with external ids, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocuments"},"post":{"tags":["Knowledge"],"summary":"Create document.","description":"","operationId":"postKnowledgeKnowledgebaseDocuments","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentReq"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"already.exists":"Document already exists"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocuments"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}":{"get":{"tags":["Knowledge"],"summary":"Get a variation for a document.","description":"","operationId":"getKnowledgeKnowledgebaseDocumentVariation","produces":["application/json"],"parameters":[{"name":"documentVariationId","in":"path","description":"Globally unique identifier for a document variation.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for a document.","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for a knowledge base.","required":true,"type":"string"},{"name":"documentState","in":"query","description":"The state of the document.","required":false,"type":"string","enum":["Draft","Published"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentVariation"},"delete":{"tags":["Knowledge"],"summary":"Delete a variation for a document.","description":"","operationId":"deleteKnowledgeKnowledgebaseDocumentVariation","produces":["application/json"],"parameters":[{"name":"documentVariationId","in":"path","description":"Globally unique identifier for a document variation.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for a document.","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for a knowledge base.","required":true,"type":"string"}],"responses":{"204":{"description":"Document variation deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["knowledge:document:delete","knowledge:document:edit"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseDocumentVariation"},"patch":{"tags":["Knowledge"],"summary":"Update a variation for a document.","description":"","operationId":"patchKnowledgeKnowledgebaseDocumentVariation","produces":["application/json"],"parameters":[{"name":"documentVariationId","in":"path","description":"Globally unique identifier for a document variation.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for a document.","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for a knowledge base.","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/DocumentVariation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Body should have a value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Submitted variation is either null or contains a null field.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","knowledge.variation.empty.request":"The request for knowledge variation was empty."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseDocumentVariation"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations":{"get":{"tags":["Knowledge"],"summary":"Get variations for a document.","description":"","operationId":"getKnowledgeKnowledgebaseDocumentVariations","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"documentState","in":"query","description":"The state of the document.","required":false,"type":"string","enum":["Draft","Published"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentVariations"},"post":{"tags":["Knowledge"],"summary":"Create a variation for a document.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentVariations","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/DocumentVariation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Body should have a value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","already.exists":"Variation already exists","constraint.validation":"Submitted variation is either null or contains a null field.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","knowledge.variation.empty.request":"The request for knowledge variation was empty."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["knowledge:document:add","knowledge:document:edit"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentVariations"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}":{"get":{"tags":["Knowledge"],"summary":"Get variation for the given document version.","description":"","operationId":"getKnowledgeKnowledgebaseDocumentVersionVariation","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Globally unique identifier for the document version.","required":true,"type":"string"},{"name":"variationId","in":"path","description":"Globally unique identifier for the document version variation.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentVersionVariation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentVersion:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentVersionVariation"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations":{"get":{"tags":["Knowledge"],"summary":"Get variations for the given document version.","description":"","operationId":"getKnowledgeKnowledgebaseDocumentVersionVariations","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Globally unique identifier for the document version.","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentVersionVariationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentVersion:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentVersionVariations"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/copies":{"post":{"tags":["Knowledge"],"summary":"Indicate that the document was copied by the user.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentCopies","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentCopy"}}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Document not found.","document.variation.not.found":"Document variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentCopy:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentCopies"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/presentations":{"post":{"tags":["Knowledge"],"summary":"Indicate that documents were presented to the user.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentsPresentations","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentPresentation"}}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Document not found.","document.variation.not.found":"Document variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentPresentation:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentsPresentations"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}":{"get":{"tags":["Knowledge"],"summary":"Get a single feedback record given on a document","description":"","operationId":"getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"name":"feedbackId","in":"path","description":"Feedback ID.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentFeedbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Feedback not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["knowledge:feedback:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback":{"get":{"tags":["Knowledge"],"summary":"Get a list of feedback records given on a document","description":"","operationId":"getKnowledgeKnowledgebaseDocumentFeedback","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"onlyCommented","in":"query","description":"If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false.","required":false,"type":"boolean"},{"name":"documentVersionId","in":"query","description":"Document version ID to filter by. Supported only if onlyCommented=true is set.","required":false,"type":"string"},{"name":"documentVariationId","in":"query","description":"Document variation ID to filter by. Supported only if onlyCommented=true is set.","required":false,"type":"string"},{"name":"appType","in":"query","description":"Application type to filter by. Supported only if onlyCommented=true is set.","required":false,"type":"string","enum":["Assistant","BotFlow","MessengerKnowledgeApp","SmartAdvisor","SupportCenter"]},{"name":"queryType","in":"query","description":"Query type to filter by. Supported only if onlyCommented=true is set.","required":false,"type":"string","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},{"name":"userId","in":"query","description":"The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.","required":false,"type":"string"},{"name":"queueId","in":"query","description":"Queue ID to filter by. Supported only if onlyCommented=true is set.","required":false,"type":"string"},{"name":"state","in":"query","description":"State to filter by. Supported only if onlyCommented=true is set. Default: Final","required":false,"type":"string","enum":["All","Draft","Final"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentFeedbackResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Document not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["knowledge:feedback:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentFeedback"},"post":{"tags":["Knowledge"],"summary":"Give feedback on a document","description":"","operationId":"postKnowledgeKnowledgebaseDocumentFeedback","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentFeedback"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentFeedbackResponse"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/KnowledgeDocumentFeedbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Document version or variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["knowledge:feedback:create"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentFeedback"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:exportJob:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseExportJob"},"delete":{"tags":["Knowledge"],"summary":"Delete export job","description":"","operationId":"deleteKnowledgeKnowledgebaseExportJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"exportJobId","in":"path","description":"Export job ID","required":true,"type":"string"}],"responses":{"204":{"description":"Export job deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","constraint.validation":"Input parameters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:exportJob:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseExportJob"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs":{"post":{"tags":["Knowledge"],"summary":"Create export job","description":"","operationId":"postKnowledgeKnowledgebaseExportJobs","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeExportJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExportJobResponse"}},"202":{"description":"Export job in progress","schema":{"$ref":"#/definitions/KnowledgeExportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.reached":"Daily or monthly limit reached"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:exportJob:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseExportJobs"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}":{"get":{"tags":["Knowledge"],"summary":"Get import job report","description":"","operationId":"getKnowledgeKnowledgebaseImportJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"importJobId","in":"path","description":"Import job ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.","required":false,"type":"array","items":{"type":"string","enum":["urls"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeImportJobResponse"}},"202":{"description":"Import job in progress","schema":{"$ref":"#/definitions/KnowledgeImportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseImportJob"},"delete":{"tags":["Knowledge"],"summary":"Delete import job","description":"","operationId":"deleteKnowledgeKnowledgebaseImportJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"importJobId","in":"path","description":"Import job ID","required":true,"type":"string"}],"responses":{"204":{"description":"Import job deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","constraint.validation":"Input parameters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseImportJob"},"patch":{"tags":["Knowledge"],"summary":"Start import job","description":"","operationId":"patchKnowledgeKnowledgebaseImportJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"importJobId","in":"path","description":"Import job ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ImportStatusRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeImportJobResponse"}},"202":{"description":"Import job in progress","schema":{"$ref":"#/definitions/KnowledgeImportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseImportJob"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs":{"post":{"tags":["Knowledge"],"summary":"Create import job","description":"","operationId":"postKnowledgeKnowledgebaseImportJobs","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeImportJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeImportJobResponse"}},"202":{"description":"Import job in progress","schema":{"$ref":"#/definitions/KnowledgeImportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseImportJobs"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions":{"post":{"tags":["Knowledge"],"summary":"Query the knowledge documents to provide suggestions for auto completion.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentsSearchSuggestions","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"The ID of knowledge base containing the documents to query.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentSuggestionRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentSuggestion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","min.length.expected":"The minimum length was not reached.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:search"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentsSearchSuggestions"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:search"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentsSearch"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}":{"patch":{"tags":["Knowledge"],"summary":"Update search result.","description":"","operationId":"patchKnowledgeKnowledgebaseDocumentsSearchSearchId","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"The ID of knowledge base containing the documents to query.","required":true,"type":"string"},{"name":"searchId","in":"path","description":"Search Result ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SearchUpdateRequest"}}],"responses":{"204":{"description":"Search updated successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:search:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseDocumentsSearchSearchId"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views":{"post":{"tags":["Knowledge"],"summary":"Create view for a document.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentViews","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentView"}}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Document not found.","document.variation.not.found":"Document variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentView:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentViews"}},"/api/v2/languageunderstanding/domains/{domainId}":{"get":{"tags":["Language Understanding"],"summary":"Find an NLU Domain.","description":"","operationId":"getLanguageunderstandingDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomain"},"delete":{"tags":["Language Understanding"],"summary":"Delete an NLU Domain.","description":"","operationId":"deleteLanguageunderstandingDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"}],"responses":{"204":{"description":""},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"There was a request conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:delete","dialog:bot:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingDomain"},"patch":{"tags":["Language Understanding"],"summary":"Update an NLU Domain.","description":"","operationId":"patchLanguageunderstandingDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated NLU Domain.","required":true,"schema":{"$ref":"#/definitions/NluDomain"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.error":"The requested domain did not meet domain name and/or language conditions.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:edit","dialog:bot:edit"]},"x-purecloud-method-name":"patchLanguageunderstandingDomain"}},"/api/v2/languageunderstanding/domains":{"get":{"tags":["Language Understanding"],"summary":"Get all NLU Domains.","description":"","operationId":"getLanguageunderstandingDomains","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomains"},"post":{"tags":["Language Understanding"],"summary":"Create an NLU Domain.","description":"","operationId":"postLanguageunderstandingDomains","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The NLU Domain to create.","required":true,"schema":{"$ref":"#/definitions/NluDomain"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomain"}},"201":{"description":"","schema":{"$ref":"#/definitions/NluDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.error":"The requested domain did not meet domain name and/or language conditions.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","domain.limit":"This organization has reached limit for domains created.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:add","dialog:bot:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomains"}},"/api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}":{"get":{"tags":["Language Understanding"],"summary":"Find a Feedback","description":"","operationId":"getLanguageunderstandingDomainFeedbackFeedbackId","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"feedbackId","in":"path","description":"ID of the Feedback","required":true,"type":"string"},{"name":"fields","in":"query","description":"Fields and properties to get, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["version","dateCreated","text","intents"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluFeedbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.error":"The arguments provided do not meet the required conditions.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"feedback.not.found":"Could not find feedback model entry specified.","not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainFeedbackFeedbackId"},"delete":{"tags":["Language Understanding"],"summary":"Delete the feedback on the NLU Domain Version.","description":"","operationId":"deleteLanguageunderstandingDomainFeedbackFeedbackId","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"feedbackId","in":"path","description":"ID of the Feedback","required":true,"type":"string"}],"responses":{"204":{"description":"Feedback deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"feedback.not.found":"Could not find feedback model entry specified.","not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:delete","dialog:bot:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingDomainFeedbackFeedbackId"}},"/api/v2/languageunderstanding/domains/{domainId}/feedback":{"get":{"tags":["Language Understanding"],"summary":"Get all feedback in the given NLU Domain Version.","description":"","operationId":"getLanguageunderstandingDomainFeedback","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"intentName","in":"query","description":"The top intent name to retrieve feedback for.","required":false,"type":"string"},{"name":"assessment","in":"query","description":"The top assessment to retrieve feedback for.","required":false,"type":"string","enum":["Incorrect","Correct","Unknown","Disabled"]},{"name":"dateStart","in":"query","description":"Begin of time window as ISO-8601 date.","required":false,"type":"string","format":"date"},{"name":"dateEnd","in":"query","description":"End of time window as ISO-8601 date.","required":false,"type":"string","format":"date"},{"name":"includeDeleted","in":"query","description":"Whether to include soft-deleted items in the result.","required":false,"type":"boolean"},{"name":"language","in":"query","description":"Whether to filter response based on the language, e.g. en-us, pt-br.","required":false,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"enableCursorPagination","in":"query","description":"Enable Cursor Pagination","required":false,"type":"boolean","default":false},{"name":"includeTrainingUtterances","in":"query","description":"Include Training Utterances. By default they're included.","required":false,"type":"boolean","default":true},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned. This is considered only when enableCursorPagination=true","required":false,"type":"string"},{"name":"fields","in":"query","description":"Fields and properties to get, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["version","dateCreated","text","intents"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluFeedbackListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainFeedback"},"post":{"tags":["Language Understanding"],"summary":"Create feedback for the NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainFeedback","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"in":"body","name":"body","description":"The Feedback to create.","required":true,"schema":{"$ref":"#/definitions/NluFeedbackRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluFeedbackResponse"}},"201":{"description":"Feedback created successfully","schema":{"$ref":"#/definitions/NluFeedbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.error":"Invalid feedback data.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:add","dialog:bot:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomainFeedback"}},"/api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}":{"get":{"tags":["Language Understanding"],"summary":"Get information about a draft.","description":"","operationId":"getLanguageunderstandingMinerDraft","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"draftId","in":"path","description":"Draft ID","required":true,"type":"string"},{"name":"draftIntentId","in":"query","description":"Parameter to filter a specific intent.","required":false,"type":"string"},{"name":"draftTopicId","in":"query","description":"Parameter to filter a specific topic.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Draft"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:draft:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerDraft"},"delete":{"tags":["Language Understanding"],"summary":"Delete a draft","description":"","operationId":"deleteLanguageunderstandingMinerDraft","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"draftId","in":"path","description":"Draft ID","required":true,"type":"string"}],"responses":{"204":{"description":"Draft deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:draft:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingMinerDraft"},"patch":{"tags":["Language Understanding"],"summary":"Save information for the draft. Either topic draft or intent draft should be sent.","description":"","operationId":"patchLanguageunderstandingMinerDraft","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"draftId","in":"path","description":"Draft ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DraftRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Draft"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:draft:edit"]},"x-purecloud-method-name":"patchLanguageunderstandingMinerDraft"}},"/api/v2/languageunderstanding/miners/{minerId}/drafts":{"get":{"tags":["Language Understanding"],"summary":"Retrieve the list of drafts created.","description":"","operationId":"getLanguageunderstandingMinerDrafts","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DraftListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:draft:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerDrafts"},"post":{"tags":["Language Understanding"],"summary":"Create a new draft resource.","description":"","operationId":"postLanguageunderstandingMinerDrafts","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Details for creating draft resource","required":true,"schema":{"$ref":"#/definitions/Draft"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Draft"}},"201":{"description":"Draft created successfully","schema":{"$ref":"#/definitions/Draft"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:draft:add"]},"x-purecloud-method-name":"postLanguageunderstandingMinerDrafts"}},"/api/v2/languageunderstanding/miners/{minerId}/intents/{intentId}":{"get":{"tags":["Language Understanding"],"summary":"Get information about a mined intent","description":"","operationId":"getLanguageunderstandingMinerIntent","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"intentId","in":"path","description":"The ID of the intent to be retrieved.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Option to fetch utterances","required":false,"type":"string","enum":["phrases","utterances"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MinerIntent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:minerIntent:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerIntent"}},"/api/v2/languageunderstanding/miners/{minerId}/intents":{"get":{"tags":["Language Understanding"],"summary":"Retrieve a list of mined intents.","description":"","operationId":"getLanguageunderstandingMinerIntents","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Option to fetch utterances.","required":false,"type":"string","enum":["phrases","utterances"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MinedIntentsListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:minerIntent:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerIntents"}},"/api/v2/languageunderstanding/miners/{minerId}":{"get":{"tags":["Language Understanding"],"summary":"Get information about a miner.","description":"","operationId":"getLanguageunderstandingMiner","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Miner"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:view"]},"x-purecloud-method-name":"getLanguageunderstandingMiner"},"delete":{"tags":["Language Understanding"],"summary":"Delete a miner.","description":"","operationId":"deleteLanguageunderstandingMiner","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"}],"responses":{"204":{"description":"Miner deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingMiner"}},"/api/v2/languageunderstanding/miners/{minerId}/execute":{"post":{"tags":["Language Understanding"],"summary":"Start the mining process. Specify date range pair with mediaType, queueIds, participantType for mining data from Genesys Cloud. Specify only uploadKey for mining through an external file.","description":"","operationId":"postLanguageunderstandingMinerExecute","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MinerExecuteRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Miner"}},"202":{"description":"Processing request","schema":{"$ref":"#/definitions/Miner"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:execute"]},"x-purecloud-method-name":"postLanguageunderstandingMinerExecute"}},"/api/v2/languageunderstanding/miners":{"get":{"tags":["Language Understanding"],"summary":"Retrieve the list of miners created.","description":"","operationId":"getLanguageunderstandingMiners","produces":["application/json"],"parameters":[{"name":"minerType","in":"query","description":"Type of miner, either intent or topic","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MinerListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:view"]},"x-purecloud-method-name":"getLanguageunderstandingMiners"},"post":{"tags":["Language Understanding"],"summary":"Create a unique miner.","description":"","operationId":"postLanguageunderstandingMiners","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Details for creating a new miner resource.","required":true,"schema":{"$ref":"#/definitions/Miner"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Miner"}},"201":{"description":"Miner created successfully","schema":{"$ref":"#/definitions/Miner"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:add"]},"x-purecloud-method-name":"postLanguageunderstandingMiners"}},"/api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}":{"get":{"tags":["Language Understanding"],"summary":"Retrieves details of a particular topic.","description":"","operationId":"getLanguageunderstandingMinerTopic","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"topicId","in":"path","description":"The ID of the topic to be retrieved.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Option to fetch phrases","required":false,"type":"string","enum":["phrases","utterances"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MinerTopic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerTopic"}},"/api/v2/languageunderstanding/miners/{minerId}/topics":{"get":{"tags":["Language Understanding"],"summary":"Retrieve a list of mined topics.","description":"","operationId":"getLanguageunderstandingMinerTopics","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MinerTopicsListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerTopics"}},"/api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}/phrases/{phraseId}":{"get":{"tags":["Language Understanding"],"summary":"Retrieves utterances related to a phrase in a topic.","description":"","operationId":"getLanguageunderstandingMinerTopicPhrase","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"topicId","in":"path","description":"The ID of the topic to be retrieved.","required":true,"type":"string"},{"name":"phraseId","in":"path","description":"The ID of the phrase to be retrieved.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MinerTopicPhrase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerTopicPhrase"}},"/api/v2/languageunderstanding/miners/{minerId}/uploads":{"post":{"tags":["Uploads"],"summary":"Creates a presigned URL for uploading a chat corpus which will be used for mining by intent miner","description":"","operationId":"postLanguageunderstandingMinerUploads","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/Empty"}}],"responses":{"200":{"description":"Presigned URL successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:upload"]},"x-purecloud-method-name":"postLanguageunderstandingMinerUploads"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/report":{"get":{"tags":["Language Understanding"],"summary":"Retrieved quality report for the specified NLU Domain Version","description":"","operationId":"getLanguageunderstandingDomainVersionReport","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"200":{"description":"Find quality report for NLU Domain Version.","schema":{"$ref":"#/definitions/NluDomainVersionQualityReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainVersionReport"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}":{"get":{"tags":["Language Understanding"],"summary":"Find an NLU Domain Version.","description":"","operationId":"getLanguageunderstandingDomainVersion","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"},{"name":"includeUtterances","in":"query","description":"Whether utterances for intent definition should be included when marshalling response.","required":false,"type":"boolean"}],"responses":{"200":{"description":"Retrieved the specified NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.not.found":"Could not find version specified.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainVersion"},"put":{"tags":["Language Understanding"],"summary":"Update an NLU Domain Version.","description":"","operationId":"putLanguageunderstandingDomainVersion","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated NLU Domain Version.","required":true,"schema":{"$ref":"#/definitions/NluDomainVersion"}}],"responses":{"200":{"description":"Updated the specified NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.error":"The arguments provided do not meet the required conditions.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.not.found":"Could not find version model entry specified.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.published":"The domain version is already published and therefore immutable.","training.in.progress":"The request could not be completed due to a conflict with the current state of the target resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service not available":"The service is not available.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:edit","dialog:botVersion:edit"]},"x-purecloud-method-name":"putLanguageunderstandingDomainVersion"},"delete":{"tags":["Language Understanding"],"summary":"Delete an NLU Domain Version","description":"","operationId":"deleteLanguageunderstandingDomainVersion","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted the specified NLU Domain Version"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.not.found":"Could not find version model entry specified.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.evaluation.in.progress":"The request could not be completed due to a conflict with the current state of the target resource.","training.in.progress":"The request could not be completed due to a conflict with the current state of the target resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service not available":"The service is not available.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:delete","dialog:botVersion:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingDomainVersion"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/publish":{"post":{"tags":["Language Understanding"],"summary":"Publish the draft NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainVersionPublish","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersion"}},"201":{"description":"Published the specified NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","version.untrained":"The version cannot be published as it's not trained.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","domain.not.found":"Could not find domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.published":"The domain version is already published and therefore immutable."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:add","dialog:botVersion:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersionPublish"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/train":{"post":{"tags":["Language Understanding"],"summary":"Train the draft NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainVersionTrain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersionTrainingResponse"}},"202":{"description":"Issued training instruction for the draft NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersionTrainingResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.not.found":"Could not find version model entry specified.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.published":"The domain version is already published and therefore immutable.","training.in.progress":"The request could not be completed due to a conflict with the current state of the target resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"training error":"The service is not available.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service not available":"The service is not available.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:edit","dialog:botVersion:edit"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersionTrain"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/detect":{"post":{"tags":["Language Understanding"],"summary":"Detect intent, entities, etc. in the submitted text using the specified NLU domain version.","description":"","operationId":"postLanguageunderstandingDomainVersionDetect","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"},{"in":"body","name":"body","description":"The input data to perform detection on.","required":true,"schema":{"$ref":"#/definitions/NluDetectionRequest"}}],"responses":{"200":{"description":"Requested NLU detection for the given input using the specified NLU domain version","schema":{"$ref":"#/definitions/NluDetectionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.intent.name":"Invalid context provided: intent name is not valid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.entity.name":"Invalid context provided: entity name is not valid.","constraint.validation":"%s","version.untrained":"The version cannot be used for detection as it's not trained.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersionDetect"}},"/api/v2/languageunderstanding/domains/{domainId}/versions":{"get":{"tags":["Language Understanding"],"summary":"Get all NLU Domain Versions for a given Domain.","description":"","operationId":"getLanguageunderstandingDomainVersions","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"includeUtterances","in":"query","description":"Whether utterances for intent definition should be included when marshalling response.","required":false,"type":"boolean"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainVersions"},"post":{"tags":["Language Understanding"],"summary":"Create an NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainVersions","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"in":"body","name":"body","description":"The NLU Domain Version to create.","required":true,"schema":{"$ref":"#/definitions/NluDomainVersion"}},{"name":"includeUtterances","in":"query","description":"Whether utterances for intent definition should be included when marshalling response.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersion"}},"201":{"description":"Created an NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.error":"The arguments provided do not meet the required conditions.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:add","dialog:botVersion:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersions"}},"/api/v2/license/definitions/{licenseId}":{"get":{"tags":["License"],"summary":"Get PureCloud license definition.","description":"","operationId":"getLicenseDefinition","produces":["application/json"],"parameters":[{"name":"licenseId","in":"path","description":"ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add","authorization:license:view"]},"x-purecloud-method-name":"getLicenseDefinition"}},"/api/v2/license/definitions":{"get":{"tags":["License"],"summary":"Get all PureCloud license definitions available for the organization.","description":"","operationId":"getLicenseDefinitions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/LicenseDefinition"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add","authorization:license:view"]},"x-purecloud-method-name":"getLicenseDefinitions"}},"/api/v2/license/infer":{"post":{"tags":["License"],"summary":"Get a list of licenses inferred based on a list of roleIds","description":"","operationId":"postLicenseInfer","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The roleIds to use while inferring licenses","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-purecloud-method-name":"postLicenseInfer"}},"/api/v2/license/toggles/{featureName}":{"get":{"tags":["License"],"summary":"Deprecated - no alternative required. This operation will always return 'true' for requested toggles","description":"","operationId":"getLicenseToggle","produces":["application/json"],"parameters":[{"name":"featureName","in":"path","description":"featureName","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseOrgToggle"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-purecloud-method-name":"getLicenseToggle"},"post":{"tags":["License"],"summary":"Deprecated. No alternative required - this endpoint has no effect","description":"","operationId":"postLicenseToggle","produces":["application/json"],"parameters":[{"name":"featureName","in":"path","description":"featureName","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseOrgToggle"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license"]}],"x-purecloud-method-name":"postLicenseToggle"}},"/api/v2/license/organization":{"post":{"tags":["License"],"summary":"Update the organization's license assignments in a batch.","description":"","operationId":"postLicenseOrganization","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The license assignments to update.","required":false,"schema":{"$ref":"#/definitions/LicenseBatchAssignmentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/LicenseUpdateStatus"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postLicenseOrganization"}},"/api/v2/license/users/{userId}":{"get":{"tags":["License"],"summary":"Get licenses for specified user.","description":"","operationId":"getLicenseUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add","authorization:license:view"]},"x-purecloud-method-name":"getLicenseUser"}},"/api/v2/license/users":{"get":{"tags":["License"],"summary":"Get a page of users and their licenses","description":"Retrieve a page of users in an organization along with the licenses they possess.","operationId":"getLicenseUsers","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserLicensesEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-purecloud-method-name":"getLicenseUsers"},"post":{"tags":["License"],"summary":"Fetch user licenses in a batch.","description":"","operationId":"postLicenseUsers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The user IDs to fetch.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add","authorization:license:view"]},"x-purecloud-method-name":"postLicenseUsers"}},"/api/v2/organizations/limits/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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["limits:organization:view"]},"x-purecloud-method-name":"getOrganizationsLimitsChangerequest"}},"/api/v2/organizations/limits/changerequests":{"get":{"tags":["Organization"],"summary":"Get the available limit change requests","description":"Timestamp interval defaults to the last 365 days if both query parameters are omitted. If only one parameter is omitted, the interval will default to a 180 day range in the specified direction.","operationId":"getOrganizationsLimitsChangerequests","produces":["application/json"],"parameters":[{"name":"after","in":"query","description":"Timestamp indicating the date to begin after when searching for requests.","required":false,"type":"integer","format":"int64"},{"name":"before","in":"query","description":"Timestamp indicating the date to end before when searching for requests.","required":false,"type":"integer","format":"int64"},{"name":"status","in":"query","description":"Status of the request to be filtered by","required":false,"type":"string","enum":["Approved","Rejected","Rollback","Pending","Open","SecondaryApprovalNamespacesAdded","ReviewerApproved","ReviewerRejected","ReviewerRollback","ImplementingChange","ChangeImplemented","ImplementingRollback","RollbackImplemented"]},{"name":"pageSize","in":"query","description":"Page Size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["statusHistory"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LimitChangeRequestsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.override.requests":"Only 100 override requests can be requested at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["limits:organization:view"]},"x-purecloud-method-name":"getOrganizationsLimitsChangerequests"}},"/api/v2/organizations/limits/docs":{"get":{"tags":["Organization"],"summary":"Get limit documentation","description":"","operationId":"getOrganizationsLimitsDocs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LimitDocumentation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsLimitsDocs"}},"/api/v2/organizations/limits/docs/freetrial":{"get":{"tags":["Organization"],"summary":"Get free trial limit documentation","description":"","operationId":"getOrganizationsLimitsDocsFreetrial","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FreeTrialLimitDocs"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsLimitsDocsFreetrial"}},"/api/v2/organizations/limits/namespaces":{"get":{"tags":["Organization"],"summary":"Get the available limit namespaces","description":"","operationId":"getOrganizationsLimitsNamespaces","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":100,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PagedNamespaceListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsLimitsNamespaces"}},"/api/v2/organizations/limits/namespaces/{namespaceName}":{"get":{"tags":["Organization"],"summary":"Get the effective limits in a namespace for an organization","description":"","operationId":"getOrganizationsLimitsNamespace","produces":["application/json"],"parameters":[{"name":"namespaceName","in":"path","description":"The namespace to fetch limits for","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LimitsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"The provided namespace is not valid or does not have any viewable limits"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsLimitsNamespace"}},"/api/v2/organizations/limits/namespaces/{namespaceName}/defaults":{"get":{"tags":["Organization"],"summary":"Get the default limits in a namespace for an organization","description":"","operationId":"getOrganizationsLimitsNamespaceDefaults","produces":["application/json"],"parameters":[{"name":"namespaceName","in":"path","description":"The namespace to fetch defaults limits for","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LimitsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"The provided namespace is not valid or does not have any viewable limits"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsLimitsNamespaceDefaults"}},"/api/v2/diagnostics/logcapture/browser/entries/download/jobs/{jobId}":{"get":{"tags":["Log Capture"],"summary":"Gets status of async download execution","description":"","operationId":"getDiagnosticsLogcaptureBrowserEntriesDownloadJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogCaptureDownloadExecutionResponse"}},"202":{"description":"In progress - Download execution is in progress.","schema":{"$ref":"#/definitions/LogCaptureDownloadExecutionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"download.file.not.found":"No entries found for user; empty file not uploaded","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture","logcapture:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["troubleshooting:logCapture:view"]},"x-purecloud-method-name":"getDiagnosticsLogcaptureBrowserEntriesDownloadJob"}},"/api/v2/diagnostics/logcapture/browser/entries/download/jobs":{"post":{"tags":["Log Capture"],"summary":"Creates an async download execution","description":"","operationId":"postDiagnosticsLogcaptureBrowserEntriesDownloadJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/LogCaptureQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogCaptureDownloadExecutionResponse"}},"202":{"description":"Accepted - Download execution is accepted.","schema":{"$ref":"#/definitions/LogCaptureDownloadExecutionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture","logcapture:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["troubleshooting:logCapture:add"]},"x-purecloud-method-name":"postDiagnosticsLogcaptureBrowserEntriesDownloadJobs"}},"/api/v2/diagnostics/logcapture/browser/entries/query":{"post":{"tags":["Log Capture"],"summary":"Query collected log entries. It returns a limited amount of records, to get all records use download endpoint.","description":"","operationId":"postDiagnosticsLogcaptureBrowserEntriesQuery","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/LogCaptureQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogCaptureQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture","logcapture:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["troubleshooting:logCapture:view"]},"x-purecloud-method-name":"postDiagnosticsLogcaptureBrowserEntriesQuery"}},"/api/v2/diagnostics/logcapture/browser/users":{"get":{"tags":["Log Capture"],"summary":"Get all log capture enabled users for an org","description":"","operationId":"getDiagnosticsLogcaptureBrowserUsers","produces":["application/json"],"parameters":[{"name":"includeExpired","in":"query","description":"Include expired users with log captures still available for search or download","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PagelessEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture","logcapture:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["troubleshooting:logCapture:view"]},"x-purecloud-method-name":"getDiagnosticsLogcaptureBrowserUsers"}},"/api/v2/diagnostics/logcapture/browser/users/{userId}":{"get":{"tags":["Log Capture"],"summary":"Get log capture configuration for the user","description":"","operationId":"getDiagnosticsLogcaptureBrowserUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The id of the user to get browser log capture configuration","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogCaptureUserConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture","logcapture:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["troubleshooting:logCapture:view"]},"x-purecloud-method-name":"getDiagnosticsLogcaptureBrowserUser"},"post":{"tags":["Log Capture"],"summary":"Enable log capture for a user or update expiration","description":"","operationId":"postDiagnosticsLogcaptureBrowserUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The id of the user to enable browser log capture","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/LogCaptureUserConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogCaptureUserConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["troubleshooting:logCapture:add"]},"x-purecloud-method-name":"postDiagnosticsLogcaptureBrowserUser"},"delete":{"tags":["Log Capture"],"summary":"Disable browser log capture for the user","description":"","operationId":"deleteDiagnosticsLogcaptureBrowserUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The id of the user to disable browser log capture","required":true,"type":"string"}],"responses":{"204":{"description":"Browser log capture successfully disabled for the user"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["troubleshooting:logCapture:delete"]},"x-purecloud-method-name":"deleteDiagnosticsLogcaptureBrowserUser"}},"/api/v2/messaging/settings":{"get":{"tags":["Messaging"],"summary":"Get a list of messaging settings","description":"","operationId":"getMessagingSettings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingConfigListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform","messaging-platform:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:view"]},"x-purecloud-method-name":"getMessagingSettings"},"post":{"tags":["Messaging"],"summary":"Create a messaging setting","description":"","operationId":"postMessagingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"MessagingSetting","required":true,"schema":{"$ref":"#/definitions/MessagingSettingRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"201":{"description":"Operation was successful","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["messaging:setting:add"]},"x-purecloud-method-name":"postMessagingSettings"}},"/api/v2/messaging/settings/default":{"get":{"tags":["Messaging"],"summary":"Get the organization's default settings that will be used as the default when creating an integration.","description":"When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.","operationId":"getMessagingSettingsDefault","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform","messaging-platform:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:view"]},"x-purecloud-method-name":"getMessagingSettingsDefault"},"put":{"tags":["Messaging"],"summary":"Set the organization's default settings that may be applied to an integration when it is created.","description":"When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.","operationId":"putMessagingSettingsDefault","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Messaging Setting ID","required":true,"schema":{"$ref":"#/definitions/MessagingSettingDefaultRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:edit"]},"x-purecloud-method-name":"putMessagingSettingsDefault"},"delete":{"tags":["Messaging"],"summary":"Delete the organization's default setting, a global default will be applied to integrations without settings","description":"When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.","operationId":"deleteMessagingSettingsDefault","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:delete"]},"x-purecloud-method-name":"deleteMessagingSettingsDefault"}},"/api/v2/messaging/settings/{messageSettingId}":{"get":{"tags":["Messaging"],"summary":"Get a messaging setting","description":"","operationId":"getMessagingSetting","produces":["application/json"],"parameters":[{"name":"messageSettingId","in":"path","description":"Message Settings ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform","messaging-platform:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:view"]},"x-purecloud-method-name":"getMessagingSetting"},"delete":{"tags":["Messaging"],"summary":"Delete a messaging setting","description":"","operationId":"deleteMessagingSetting","produces":["application/json"],"parameters":[{"name":"messageSettingId","in":"path","description":"Message Settings ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:delete"]},"x-purecloud-method-name":"deleteMessagingSetting"},"patch":{"tags":["Messaging"],"summary":"Update a messaging setting","description":"","operationId":"patchMessagingSetting","produces":["application/json"],"parameters":[{"name":"messageSettingId","in":"path","description":"Message Settings ID","required":true,"type":"string"},{"in":"body","name":"body","description":"MessagingSetting","required":true,"schema":{"$ref":"#/definitions/MessagingSettingRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:edit"]},"x-purecloud-method-name":"patchMessagingSetting"}},"/api/v2/messaging/supportedcontent/{supportedContentId}":{"get":{"tags":["Messaging"],"summary":"Get a supported content profile","description":"Deprecated - use GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement","operationId":"getMessagingSupportedcontentSupportedContentId","produces":["application/json"],"parameters":[{"name":"supportedContentId","in":"path","description":"Supported Content ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform","messaging-platform:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:view"]},"x-purecloud-method-name":"getMessagingSupportedcontentSupportedContentId"},"delete":{"tags":["Messaging"],"summary":"Delete a supported content profile","description":"Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement","operationId":"deleteMessagingSupportedcontentSupportedContentId","produces":["application/json"],"parameters":[{"name":"supportedContentId","in":"path","description":"Supported Content ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"supported.content.in.use":"The supported content profile is in use by an integration","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:delete"]},"x-purecloud-method-name":"deleteMessagingSupportedcontentSupportedContentId"},"patch":{"tags":["Messaging"],"summary":"Update a supported content profile","description":"Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement","operationId":"patchMessagingSupportedcontentSupportedContentId","produces":["application/json"],"parameters":[{"name":"supportedContentId","in":"path","description":"Supported Content ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SupportedContent","required":true,"schema":{"$ref":"#/definitions/SupportedContent"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.media.type":"A media type string as defined by RFC 2046 is invalid. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","maximum.supported.content.media.types.exceeded":"The maximum number of media types defined for the supported content profile has been exceeded","invalid.supported.content":"The supported content request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:edit"]},"x-purecloud-method-name":"patchMessagingSupportedcontentSupportedContentId"}},"/api/v2/messaging/supportedcontent":{"get":{"tags":["Messaging"],"summary":"Get a list of Supported Content profiles","description":"Deprecated - use GET /api/v2/conversations/messaging/supportedcontent as replacement","operationId":"getMessagingSupportedcontent","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform","messaging-platform:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:view"]},"x-purecloud-method-name":"getMessagingSupportedcontent"},"post":{"tags":["Messaging"],"summary":"Create a Supported Content profile","description":"Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement","operationId":"postMessagingSupportedcontent","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SupportedContent","required":true,"schema":{"$ref":"#/definitions/SupportedContent"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"201":{"description":"Operation was successful","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.media.type":"A media type string as defined by RFC 2046. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types.","maximum.supported.content.profiles.exceeded":"The maximum number of supported content profiles created for an organization has been exceeded","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","maximum.supported.content.media.types.exceeded":"The maximum number of media types defined for the supported content profile has been exceeded","invalid.supported.content":"The supported content request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["messaging:supportedContent:add"]},"x-purecloud-method-name":"postMessagingSupportedcontent"}},"/api/v2/ipranges":{"get":{"tags":["Utilities"],"summary":"Get public ip address ranges for Genesys Cloud","description":"","operationId":"getIpranges","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IpAddressRangeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getIpranges"}},"/api/v2/webdeployments/deployments/{deploymentId}/cobrowse/{sessionId}":{"get":{"tags":["Web Deployments"],"summary":"Retrieves a cobrowse session","description":"","operationId":"getWebdeploymentsDeploymentCobrowseSessionId","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"WebMessaging deployment ID","required":true,"type":"string"},{"name":"sessionId","in":"path","description":"Cobrowse session id or join code","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CobrowseWebMessagingSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getWebdeploymentsDeploymentCobrowseSessionId"},"delete":{"tags":["Web Deployments"],"summary":"Deletes a cobrowse session","description":"","operationId":"deleteWebdeploymentsDeploymentCobrowseSessionId","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"WebMessaging deployment ID","required":true,"type":"string"},{"name":"sessionId","in":"path","description":"Cobrowse session id or join code","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"deleteWebdeploymentsDeploymentCobrowseSessionId"}},"/api/v2/journey/deployments/{deploymentId}/actionevent":{"post":{"tags":["Journey"],"summary":"Sends an action event, which is used for changing the state of actions that have been offered to the user.","description":"","operationId":"postJourneyDeploymentActionevent","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The ID of the deployment sending the beacon.","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ActionEventRequest"}}],"responses":{"204":{"description":"Successfully transitioned the actions state. This does not return the action."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"There was an issue with this transition. The reason is returned in the body.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","access.denied":"Event Collection is not enabled","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.action":"The Action, Deployment, or Session was not was found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.action.state":"Invalid Action state transition"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postJourneyDeploymentActionevent"}},"/api/v2/journey/deployments/{deploymentId}/appevents":{"post":{"tags":["Journey"],"summary":"Send a journey app event, used for tracking customer activity on an application.","description":"","operationId":"postJourneyDeploymentAppevents","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The ID of the deployment sending the app event.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AppEventRequest"}}],"responses":{"200":{"description":"Request completed successfully.","schema":{"$ref":"#/definitions/AppEventResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"The app event on the request is older than the start date of the active session and will not be processed."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postJourneyDeploymentAppevents"}},"/api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping":{"get":{"tags":["Journey"],"summary":"Send a ping.","description":"","operationId":"getJourneyDeploymentCustomerPing","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The ID of the deployment sending the ping.","required":true,"type":"string"},{"name":"customerCookieId","in":"path","description":"ID of the customer associated with the ping.","required":true,"type":"string"},{"name":"dl","in":"query","description":"Document Location: 1) Web Page URL if overridden or URL fragment identifier (window.location.hash). OR 2) Application screen name that the ping request was sent from in the app. e.g. 'home' or 'help. Pings without this parameter will not return actions.","required":false,"type":"string"},{"name":"dt","in":"query","description":"Document Title. A human readable name for the page or screen","required":false,"type":"string"},{"name":"appNamespace","in":"query","description":"Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions","required":false,"type":"string"},{"name":"sessionId","in":"query","description":"UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session","required":false,"type":"string"},{"name":"sinceLastBeaconMilliseconds","in":"query","description":"How long (milliseconds) since the last app event or beacon was sent. The response may return a pollInternvalMilliseconds to reduce the frequency of pings.","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeploymentPing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Unauthorized to send ping request.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","server.unavailable":"The service is currently unavailable."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getJourneyDeploymentCustomerPing"}},"/api/v2/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":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"The 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/{documentId}/feedback":{"post":{"tags":["Knowledge"],"summary":"Give feedback on a document","description":"","operationId":"postKnowledgeGuestSessionDocumentFeedback","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeGuestDocumentFeedback"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeGuestDocumentFeedback"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/KnowledgeGuestDocumentFeedback"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"Document version or variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessionDocumentFeedback"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents":{"get":{"tags":["Knowledge"],"summary":"Get documents.","description":"","operationId":"getKnowledgeGuestSessionDocuments","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"categoryId","in":"query","description":"If specified, retrieves documents associated with category ids, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeGuestDocumentResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getKnowledgeGuestSessionDocuments"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}":{"get":{"tags":["Knowledge"],"summary":"Get a knowledge document by ID.","description":"","operationId":"getKnowledgeGuestSessionDocument","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeGuestDocumentResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"Document not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getKnowledgeGuestSessionDocument"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/views":{"post":{"tags":["Knowledge"],"summary":"Create view event for a document.","description":"","operationId":"postKnowledgeGuestSessionDocumentViews","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeGuestDocumentView"}}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"Document not found.","document.variation.not.found":"Document variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessionDocumentViews"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/copies":{"post":{"tags":["Knowledge"],"summary":"Indicate that the document was copied by the user.","description":"","operationId":"postKnowledgeGuestSessionDocumentCopies","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeGuestDocumentCopy"}}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"Document not found.","document.variation.not.found":"Document variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessionDocumentCopies"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/presentations":{"post":{"tags":["Knowledge"],"summary":"Indicate that documents were presented to the user.","description":"","operationId":"postKnowledgeGuestSessionDocumentsPresentations","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeGuestDocumentPresentation"}}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"Document not found","document.variation.not.found":"Document variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessionDocumentsPresentations"}},"/api/v2/knowledge/guest/sessions/{sessionId}/categories":{"get":{"tags":["Knowledge"],"summary":"Get categories","description":"","operationId":"getKnowledgeGuestSessionCategories","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"parentId","in":"query","description":"If specified, retrieves the children categories by parent category ID.","required":false,"type":"string"},{"name":"isRoot","in":"query","description":"If specified, retrieves only the root categories.","required":false,"type":"boolean"},{"name":"name","in":"query","description":"Filter to return the categories that starts with the given category name.","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically","required":false,"type":"string","default":"Name","enum":["Name","Hierarchy"]},{"name":"expand","in":"query","description":"The specified entity attribute will be filled. Supported value:\"Ancestors\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors.","required":false,"type":"string"},{"name":"includeDocumentCount","in":"query","description":"If specified, retrieves the number of documents related to category.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GuestCategoryResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","session.not.found":"Session not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getKnowledgeGuestSessionCategories"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/search":{"post":{"tags":["Knowledge"],"summary":"Search the documents in a guest session.","description":"","operationId":"postKnowledgeGuestSessionDocumentsSearch","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields, if any, to expand for each document in the search result matching the query.","required":false,"type":"array","items":{"type":"string","enum":["documentVariations","documentAlternatives","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessionDocumentsSearch"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions":{"post":{"tags":["Knowledge"],"summary":"Query the knowledge documents to provide suggestions for auto completion.","description":"","operationId":"postKnowledgeGuestSessionDocumentsSearchSuggestions","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeGuestDocumentSuggestionRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeGuestDocumentSuggestion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessionDocumentsSearchSuggestions"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}":{"patch":{"tags":["Knowledge"],"summary":"Update search result.","description":"","operationId":"patchKnowledgeGuestSessionDocumentsSearchSearchId","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"searchId","in":"path","description":"Search Result ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SearchUpdateRequest"}}],"responses":{"204":{"description":"Search updated successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid document Id.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"Search not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"patchKnowledgeGuestSessionDocumentsSearchSearchId"}},"/api/v2/knowledge/guest/sessions":{"post":{"tags":["Knowledge"],"summary":"Create guest session","description":"","operationId":"postKnowledgeGuestSessions","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeGuestSession"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeGuestSession"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/KnowledgeGuestSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"support.center.knowledge.base.id.not.set":"Knowledge base id is not set in support center configuration (when app.type is SupportCenter).","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","messenger.knowledge.base.not.enabled":"The knowledge base app is not enabled in the messenger deployment (when app.type is MessengerKnowledgeApp).","invalid.context.specified":"The context not found in the knowledgebase.","messenger.knowledge.base.id.not.set":"The knowledge base id is not set in the messenger deployment (when app.type is MessengerKnowledgeApp).","constraint.validation":"%s","app.not.found":"The app not found by deploymentId.","knowledge.base.not.found":"The knowledge base specified in the deployment configuration was not found.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","support.center.not.enabled":"Support center is not enabled in the deployment (when app.type is SupportCenter)."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessions"}},"/api/v2/quality/surveys/scorable":{"get":{"tags":["Quality"],"summary":"Get a survey as an end-customer, for the purposes of scoring it.","description":"","operationId":"getQualitySurveysScorable","produces":["application/json"],"parameters":[{"name":"customerSurveyUrl","in":"query","description":"customerSurveyUrl","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScorableSurvey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.survey.form.context.doesnt.have.valid.published.version":"All published versions of this survey form have been disabled.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getQualitySurveysScorable"},"put":{"tags":["Quality"],"summary":"Update a survey as an end-customer, for the purposes of scoring it.","description":"","operationId":"putQualitySurveysScorable","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"survey","required":true,"schema":{"$ref":"#/definitions/ScorableSurvey"}},{"name":"customerSurveyUrl","in":"query","description":"customerSurveyUrl","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScorableSurvey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.survey.unauthenticated.already.finished":"The survey is already finished.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"putQualitySurveysScorable"}},"/api/v2/documentation/search":{"get":{"tags":["Search"],"summary":"Search documentation using the q64 value returned from a previous search","description":"","operationId":"getDocumentationSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getDocumentationSearch"},"post":{"tags":["Search"],"summary":"Search documentation","description":"","operationId":"postDocumentationSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/DocumentationSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","unsupported.search.entity.type":"Search entity type is not supported."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postDocumentationSearch"}},"/api/v2/documentation/gkn/search":{"get":{"tags":["Search"],"summary":"Search gkn documentation using the q64 value returned from a previous search","description":"","operationId":"getDocumentationGknSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GKNDocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getDocumentationGknSearch"},"post":{"tags":["Search"],"summary":"Search gkn documentation","description":"","operationId":"postDocumentationGknSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/GKNDocumentationSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GKNDocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postDocumentationGknSearch"}},"/api/v2/webchat/guest/conversations":{"post":{"tags":["WebChat"],"summary":"Create an ACD chat conversation from an external customer.","description":"This endpoint will create a new ACD Chat conversation under the specified Chat Deployment.\n The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the 'memberAuthToken' field should include his JWT as generated by the 'POST /api/v2/signeddata' resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted.\n The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the 'eventStreamUri' field of the response; the conversation is not routed until the event stream is attached.","operationId":"postWebchatGuestConversations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CreateConversationRequest","required":true,"schema":{"$ref":"#/definitions/CreateWebChatConversationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateWebChatConversationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationrequest.journeycontext.customer":"The customer may not be null.","chat.error.notnull.createconversationrequest.journeycontext.triggeringaction.actionmapversion":"The actionmapversion property may not be null.","chat.error.invalid.queue":"The specified queue is not valid.","chat.error.notnull.createconversationrequest.journeycontext.triggeringaction.actionid":"The actionid property may not be null.","bad.request":"The request could not be understood by the server due to malformed syntax.","chat.error.notnull.createconversationrequest.journeycontext.customer.customerid":"The customerid property may not be null.","constraint.validation":"%s","chat.error.notnull.createconversationrequest.memberinfo.displayname":"The displayname property may not be null.","chat.error.notnull.createconversationrequest.routingtarget":"The routingtarget property may not be null.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","chat.error.notnull.createconversationrequest.journeycontext.customer.customeridtype":"The customeridtype property may not be null.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","chat.deployment.require.auth":"The deployment requires the customer member to be authenticated.","chat.error.notnull.createconversationrequest.journeycontext.customersession.sessionid":"The sessionid property may not be null.","chat.error.notnull.createconversationrequest.journeycontext.customersession.sessionidtype":"The sessionidtype property may not be null.","chat.deployment.bad.auth":"The customer member authentication has failed.","chat.error.notnull.createconversationrequest.journeycontext.triggeringaction.actionmapid":"The actionmapid property may not be null.","chat.error.createconversationrequest.routingtarget":"The routing target is not valid.","invalid.property":"Value [%s] is not a valid property for object [%s]","chat.deployment.disabled":"The web chat deployment is currently disabled.","chat.error.pattern.createconversationrequest.deploymentid":"The deploymentid property may not be null.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.invalid.flow":"Invalid chat flow","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","chat.error.bad.request":"Error occurred due to invalid request."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"origin.not.allowed":"Not allowed to create an ACD chat conversation from an external customer.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"caht.error":"Error performing chat conversation operation.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.service.timeout":"Chat service timeout error.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postWebchatGuestConversations"}},"/api/v2/webdeployments/token/refresh":{"post":{"tags":["Web Deployments"],"summary":"Refresh a JWT.","description":"","operationId":"postWebdeploymentsTokenRefresh","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/WebDeploymentsRefreshJWTRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SignedData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","parameters.missing":"Parameters are missing","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postWebdeploymentsTokenRefresh"}},"/api/v2/webdeployments/token/oauthcodegrantjwtexchange":{"post":{"tags":["Web Deployments"],"summary":"Exchange an oAuth code (obtained using the Authorization Code Flow) for a JWT that can be used by webdeployments.","description":"","operationId":"postWebdeploymentsTokenOauthcodegrantjwtexchange","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"webDeploymentsOAuthExchangeRequest","required":true,"schema":{"$ref":"#/definitions/WebDeploymentsOAuthExchangeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentsAuthorizationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","parameters.missing":"Parameters are missing","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postWebdeploymentsTokenOauthcodegrantjwtexchange"}},"/api/v2/workforcemanagement/calendar/data/ics":{"get":{"tags":["Workforce Management"],"summary":"Get ics formatted calendar based on shareable link","description":"","operationId":"getWorkforcemanagementCalendarDataIcs","produces":["text/calendar"],"parameters":[{"name":"calendarId","in":"query","description":"The id of the ics-formatted calendar","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Query parameter did not pass validation","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden 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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getWorkforcemanagementCalendarDataIcs"}},"/api/v2/notifications/availabletopics":{"get":{"tags":["Notifications"],"summary":"Get available notification topics.","description":"","operationId":"getNotificationsAvailabletopics","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["description","enforced","schema","visibility","transports","publicApiTemplateUriPaths","requiresPermissions","permissionDetails","topicParameters"]},"collectionFormat":"multi"},{"name":"includePreview","in":"query","description":"Whether or not to include Preview topics","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"getNotificationsAvailabletopics"}},"/api/v2/notifications/channels":{"get":{"tags":["Notifications"],"summary":"The list of existing channels","description":"","operationId":"getNotificationsChannels","produces":["application/json"],"parameters":[{"name":"includechannels","in":"query","description":"Show user's channels for this specific token or across all tokens for this user and app. Channel Ids for other access tokens will not be shown, but will be presented to show their existence.","required":false,"type":"string","default":"token","enum":["token","oauthclient"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"getNotificationsChannels"},"post":{"tags":["Notifications"],"summary":"Create a new channel","description":"There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date. Channels without an active connection will be removed first.","operationId":"postNotificationsChannels","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Channel"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"postNotificationsChannels"}},"/api/v2/notifications/channels/{channelId}":{"head":{"tags":["Notifications"],"summary":"Verify a channel still exists and is valid","description":"Returns a 200 OK if channel exists, and a 404 Not Found if it doesn't","operationId":"headNotificationsChannel","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"headNotificationsChannel"}},"/api/v2/notifications/channels/{channelId}/subscriptions":{"get":{"tags":["Notifications"],"summary":"The list of all subscriptions for this channel","description":"","operationId":"getNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"getNotificationsChannelSubscriptions"},"post":{"tags":["Notifications"],"summary":"Add a list of subscriptions to the existing list of subscriptions","description":"","operationId":"postNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}}},{"name":"ignoreErrors","in":"query","description":"Optionally prevent throwing of errors for failed permissions checks.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.subscription.too.many.subscriptions":"Too many subscriptions","notification.transport.not.allowed":"unable to subscribe, transport type not permitted.","notification.invalid.topic":"The subscription topic is not valid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","notification.unable.to.get.channel.id":"Unable to get channel Id.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"The service is currently unavailable."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"putNotificationsChannelSubscriptions"},"delete":{"tags":["Notifications"],"summary":"Remove all subscriptions","description":"","operationId":"deleteNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"deleteNotificationsChannelSubscriptions"}},"/api/v2/oauth/clients/{clientId}":{"get":{"tags":["OAuth"],"summary":"Get OAuth Client","description":"","operationId":"getOauthClient","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","client.not.found":"Client was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"getOauthClient"},"put":{"tags":["OAuth"],"summary":"Update OAuth Client","description":"","operationId":"putOauthClient","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Client","required":true,"schema":{"$ref":"#/definitions/OAuthClientRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.client.role":"Client role is invalid.","bad.client.state":"Client is disabled.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","bad.grant.type":"Invalid grant type.","constraint.validation":"%s","grant.type.required":"Grant type is required.","missing.client.scope":"Client scope is missing.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.client.roles":"Client roles and divisions are missing.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","client.not.found":"Client was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:edit"]},"x-purecloud-method-name":"putOauthClient"},"delete":{"tags":["OAuth"],"summary":"Delete OAuth Client","description":"","operationId":"deleteOauthClient","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","cannot.delete.client":"Clients must be marked as inactive to be eligible for deletion."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","client.not.found":"Client was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:delete"]},"x-purecloud-method-name":"deleteOauthClient"}},"/api/v2/oauth/clients/{clientId}/secret":{"post":{"tags":["OAuth"],"summary":"Regenerate Client Secret","description":"This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.","operationId":"postOauthClientSecret","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:edit"]},"x-purecloud-method-name":"postOauthClientSecret"}},"/api/v2/oauth/clients/{clientId}/usage/query":{"post":{"tags":["OAuth","Usage"],"summary":"Query for OAuth client API usage","description":"After calling this method, you will then need to poll for the query results based on the returned execution Id","operationId":"postOauthClientUsageQuery","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Query","required":true,"schema":{"$ref":"#/definitions/ApiUsageClientQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"202":{"description":"Execution not completed, check back for results","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view","usage:client:view"]},"x-purecloud-method-name":"postOauthClientUsageQuery"}},"/api/v2/oauth/clients/{clientId}/usage/summary":{"get":{"tags":["OAuth","Usage"],"summary":"Get a summary of OAuth client API usage","description":"After calling this method, you will then need to poll for the query results based on the returned execution Id","operationId":"getOauthClientUsageSummary","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"},{"name":"days","in":"query","description":"Previous number of days to query","required":false,"type":"string","default":"7"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"202":{"description":"Execution not completed, check back for results","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view","usage:client:view"]},"x-purecloud-method-name":"getOauthClientUsageSummary"}},"/api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}":{"get":{"tags":["OAuth","Usage"],"summary":"Get the results of a usage query","description":"","operationId":"getOauthClientUsageQueryResult","produces":["application/json"],"parameters":[{"name":"executionId","in":"path","description":"ID of the query execution","required":true,"type":"string"},{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiUsageQueryResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view","usage:client:view"]},"x-purecloud-method-name":"getOauthClientUsageQueryResult"}},"/api/v2/oauth/clients":{"get":{"tags":["OAuth"],"summary":"The list of OAuth clients","description":"","operationId":"getOauthClients","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClientEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"getOauthClients"},"post":{"tags":["OAuth"],"summary":"Create OAuth client","description":"The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. \nThe preferred authorizedGrantTypes is 'CODE' which requires applications to send a client ID and client secret. This is typically a web server. \nIf the client is unable to secure the client secret then the 'TOKEN' grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. \nIf a client is to be used outside of the context of a user then the 'CLIENT-CREDENTIALS' grant may be used. In this case the client must be granted roles \nvia the 'roleIds' field.","operationId":"postOauthClients","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Client","required":true,"schema":{"$ref":"#/definitions/OAuthClientRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.client.role":"Client role is invalid.","bad.client.state":"New clients can only have an active state","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","bad.grant.type":"Invalid grant type.","auth.invalid.scope":"Client has invalid scope","constraint.validation":"%s","grant.type.required":"Grant type is required.","missing.client.scope":"Client scope is missing.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","auth.too.many.clients":"Too many clients exist in this organization.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.client.roles":"Client roles and divisions are missing.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:add"]},"x-purecloud-method-name":"postOauthClients"}},"/api/v2/usage/events/definitions":{"get":{"tags":["Operational Events"],"summary":"Get all operational event definitions","description":"","operationId":"getUsageEventsDefinitions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventDefinitionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["usage","usage:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["usage:events:view"]},"x-purecloud-method-name":"getUsageEventsDefinitions"}},"/api/v2/usage/events/definitions/{eventDefinitionId}":{"get":{"tags":["Operational Events"],"summary":"Get an operational event definition by its id","description":"","operationId":"getUsageEventsDefinition","produces":["application/json"],"parameters":[{"name":"eventDefinitionId","in":"path","description":"EventDefinition id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Event definition not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["usage","usage:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["usage:events:view"]},"x-purecloud-method-name":"getUsageEventsDefinition"}},"/api/v2/orgauthorization/trustees/audits":{"post":{"tags":["Organization Authorization"],"summary":"Get Org Trustee Audits","description":"","operationId":"postOrgauthorizationTrusteesAudits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"descending"},{"in":"body","name":"body","description":"Values to scope the request.","required":true,"schema":{"$ref":"#/definitions/TrusteeAuditQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:audit:view"]},"x-purecloud-method-name":"postOrgauthorizationTrusteesAudits"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Cloned User","description":"","operationId":"getOrgauthorizationTrustorCloneduser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClonedUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorCloneduser"},"put":{"tags":["Organization Authorization"],"summary":"Creates a clone of the trustee user in the trustor org.","description":"","operationId":"putOrgauthorizationTrustorCloneduser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClonedUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"putOrgauthorizationTrustorCloneduser"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Cloned User","description":"","operationId":"deleteOrgauthorizationTrustorCloneduser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustorCloneduser"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers":{"get":{"tags":["Organization Authorization"],"summary":"The list of cloned users in the trustor organization (i.e. users with a native user record).","description":"","operationId":"getOrgauthorizationTrustorClonedusers","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClonedUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorClonedusers"}},"/api/v2/orgauthorization/trustees/default":{"get":{"tags":["Organization Authorization"],"summary":"Get organization authorization trust with Customer Care, if one exists.","description":"","operationId":"getOrgauthorizationTrusteesDefault","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:view","authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteesDefault"},"post":{"tags":["Organization Authorization"],"summary":"Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.","description":"","operationId":"postOrgauthorizationTrusteesDefault","produces":["application/json"],"parameters":[{"name":"assignDefaultRole","in":"query","description":"Assign Admin role to default pairing with Customer Care","required":false,"type":"boolean"},{"name":"autoExpire","in":"query","description":"Automatically expire pairing after 30 days","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.fields.validation.error":"One or more required properties are missing","self.trust.not.allowed":"The pairing trustee organization id cannot match the creator of the trust's organization id.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","trustee.user.or.group.required":"Trustee user or group required","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrustee:add","authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"postOrgauthorizationTrusteesDefault"}},"/api/v2/orgauthorization/pairings/{pairingId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Pairing Info","description":"","operationId":"getOrgauthorizationPairing","produces":["application/json"],"parameters":[{"name":"pairingId","in":"path","description":"Pairing Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:view","authorization:orgTrustor:view"]},"x-purecloud-method-name":"getOrgauthorizationPairing"}},"/api/v2/orgauthorization/pairings":{"post":{"tags":["Organization Authorization"],"summary":"A pairing id is created by the trustee and given to the trustor to create a trust.","description":"","operationId":"postOrgauthorizationPairings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Pairing Info","required":true,"schema":{"$ref":"#/definitions/TrustRequestCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:add"]},"x-purecloud-method-name":"postOrgauthorizationPairings"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee Group","description":"","operationId":"getOrgauthorizationTrusteeGroup","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeGroupId","in":"path","description":"Trustee Group Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeGroup"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee Group","description":"","operationId":"deleteOrgauthorizationTrusteeGroup","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeGroupId","in":"path","description":"Trustee Group Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeGroup"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roledivisions":{"put":{"tags":["Organization Authorization"],"summary":"Update Trustee Group Roles","description":"","operationId":"putOrgauthorizationTrusteeGroupRoledivisions","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeGroupId","in":"path","description":"Trustee Group Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Set of roles with corresponding divisions to apply","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrusteeGroupRoledivisions"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee Group Roles","description":"","operationId":"getOrgauthorizationTrusteeGroupRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeGroupId","in":"path","description":"Trustee Group Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeGroupRoles"},"put":{"tags":["Organization Authorization"],"summary":"Update Trustee Group Roles","description":"","operationId":"putOrgauthorizationTrusteeGroupRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeGroupId","in":"path","description":"Trustee Group Id","required":true,"type":"string"},{"in":"body","name":"body","description":"List of roles","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrusteeGroupRoles"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee Group Roles","description":"","operationId":"deleteOrgauthorizationTrusteeGroupRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeGroupId","in":"path","description":"Trustee Group Id","required":true,"type":"string"}],"responses":{"204":{"description":"Roles deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeGroupRoles"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups":{"get":{"tags":["Organization Authorization"],"summary":"The list of trustee groups for this organization (i.e. groups granted access to this organization).","description":"","operationId":"getOrgauthorizationTrusteeGroups","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeGroups"},"post":{"tags":["Organization Authorization"],"summary":"Add a group to the trust.","description":"","operationId":"postOrgauthorizationTrusteeGroups","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Trust","required":true,"schema":{"$ref":"#/definitions/TrustMemberCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:add"]},"x-purecloud-method-name":"postOrgauthorizationTrusteeGroups"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Org Trust","description":"","operationId":"getOrgauthorizationTrustee","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustee"},"put":{"tags":["Organization Authorization"],"summary":"Update Org Trust","description":"","operationId":"putOrgauthorizationTrustee","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Client","required":true,"schema":{"$ref":"#/definitions/TrustUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrustee"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Org Trust","description":"","operationId":"deleteOrgauthorizationTrustee","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustee"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee User","description":"","operationId":"getOrgauthorizationTrusteeUser","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeUser"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee User","description":"","operationId":"deleteOrgauthorizationTrusteeUser","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeUser"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roledivisions":{"put":{"tags":["Organization Authorization"],"summary":"Update Trustee User Roles","description":"","operationId":"putOrgauthorizationTrusteeUserRoledivisions","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Set of roles with corresponding divisions to apply","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrusteeUserRoledivisions"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee User Roles","description":"","operationId":"getOrgauthorizationTrusteeUserRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeUserRoles"},"put":{"tags":["Organization Authorization"],"summary":"Update Trustee User Roles","description":"","operationId":"putOrgauthorizationTrusteeUserRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"},{"in":"body","name":"body","description":"List of roles","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrusteeUserRoles"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee User Roles","description":"","operationId":"deleteOrgauthorizationTrusteeUserRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"204":{"description":"Roles deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeUserRoles"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users":{"get":{"tags":["Organization Authorization"],"summary":"The list of trustee users for this organization (i.e. users granted access to this organization).","description":"","operationId":"getOrgauthorizationTrusteeUsers","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeUsers"},"post":{"tags":["Organization Authorization"],"summary":"Add a user to the trust.","description":"","operationId":"postOrgauthorizationTrusteeUsers","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Trust","required":true,"schema":{"$ref":"#/definitions/TrustMemberCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","trustee.user.not.found":"Trustee user not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"postOrgauthorizationTrusteeUsers"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers":{"get":{"tags":["Organization Authorization"],"summary":"The list of cloned users from the trustee organization (i.e. users with a native user record).","description":"There can be no more than 5 cloned users per organization, so results are represented as simple list and not paged","operationId":"getOrgauthorizationTrusteeClonedusers","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClonedUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeClonedusers"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers/{trusteeUserId}":{"delete":{"tags":["Organization Authorization"],"summary":"Deletes cloned user","description":"","operationId":"deleteOrgauthorizationTrusteeCloneduser","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Id of the cloned user to delete","required":true,"type":"string"}],"responses":{"204":{"description":"Cloned user successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeCloneduser"}},"/api/v2/orgauthorization/trustor/audits":{"post":{"tags":["Organization Authorization"],"summary":"Get Org Trustor Audits","description":"","operationId":"postOrgauthorizationTrustorAudits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"descending"},{"in":"body","name":"body","description":"Values to scope the request.","required":true,"schema":{"$ref":"#/definitions/TrustorAuditQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:audit:view"]},"x-purecloud-method-name":"postOrgauthorizationTrustorAudits"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee Group","description":"","operationId":"getOrgauthorizationTrustorGroup","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trustorGroupId","in":"path","description":"Trustor Group Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorGroup"},"put":{"tags":["Organization Authorization"],"summary":"Add a Trustee Group to the trust.","description":"","operationId":"putOrgauthorizationTrustorGroup","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trustorGroupId","in":"path","description":"Trustor Group Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrusteeGroup:add"]},"x-purecloud-method-name":"putOrgauthorizationTrustorGroup"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee Group","description":"","operationId":"deleteOrgauthorizationTrustorGroup","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trustorGroupId","in":"path","description":"Trustor Group Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustorGroup"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/groups":{"get":{"tags":["Organization Authorization"],"summary":"The list of groups in the trustor organization (i.e. groups granted access).","description":"","operationId":"getOrgauthorizationTrustorGroups","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorGroups"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Org Trust","description":"","operationId":"getOrgauthorizationTrustor","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustor:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustor"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Org Trust","description":"","operationId":"deleteOrgauthorizationTrustor","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustor:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustor"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee User","description":"","operationId":"getOrgauthorizationTrustorUser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorUser"},"put":{"tags":["Organization Authorization"],"summary":"Add a Trustee user to the trust.","description":"","operationId":"putOrgauthorizationTrustorUser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"putOrgauthorizationTrustorUser"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee User","description":"","operationId":"deleteOrgauthorizationTrustorUser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustorUser"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/users":{"get":{"tags":["Organization Authorization"],"summary":"The list of users in the trustor organization (i.e. users granted access).","description":"","operationId":"getOrgauthorizationTrustorUsers","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorUsers"}},"/api/v2/orgauthorization/trustors":{"get":{"tags":["Organization Authorization"],"summary":"The list of organizations that have authorized/trusted your organization.","description":"","operationId":"getOrgauthorizationTrustors","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustorEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustor:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustors"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Bulk Org Trustors","description":"","operationId":"deleteOrgauthorizationTrustors","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Comma separated list of trustor ids to remove","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"Trustors deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"min.trustor.ids":"Minimum of 1 Trustor Org Id required.","max.trustor.ids":"Only 25 Trustors can be deleted at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustor:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustors","x-genesys-preview":true}},"/api/v2/orgauthorization/trustees":{"get":{"tags":["Organization Authorization"],"summary":"The list of trustees for this organization (i.e. organizations granted access to this organization).","description":"","operationId":"getOrgauthorizationTrustees","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustees"},"post":{"tags":["Organization Authorization"],"summary":"Create a new organization authorization trust. This is required to grant other organizations access to your organization.","description":"","operationId":"postOrgauthorizationTrustees","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Trust","required":true,"schema":{"$ref":"#/definitions/TrustCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"self.trust.not.allowed":"The pairing trustee organization id cannot match the creator of the trust's organization id.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","pairing.id.required":"A valid pairingId is required.","invalid.property":"Value [%s] is not a valid property for object [%s]","trustee.user.or.group.required":"Trustee user or group required","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","trustee.user.required":"At least one trustee user is required."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrustee:add","authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"postOrgauthorizationTrustees"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Bulk Org Trustees","description":"","operationId":"deleteOrgauthorizationTrustees","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Comma separated list of trustee ids to remove","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"Trustees deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","min.trustee.ids":"Minimum of 1 Trustee Org Id required.","max.trustee.ids":"Only 25 Trustees can be deleted at a time."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustees","x-genesys-preview":true}},"/api/v2/users/{userId}/outofoffice":{"get":{"tags":["Users"],"summary":"Get a OutOfOffice","description":"","operationId":"getUserOutofoffice","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutOfOffice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"User was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserOutofoffice"},"put":{"tags":["Users"],"summary":"Update an OutOfOffice","description":"","operationId":"putUserOutofoffice","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated OutOffOffice","required":true,"schema":{"$ref":"#/definitions/OutOfOffice"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutOfOffice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"putUserOutofoffice"}},"/api/v2/routing/queues/{queueId}/estimatedwaittime":{"get":{"tags":["Routing"],"summary":"Get Estimated Wait Time","description":"","operationId":"getRoutingQueueEstimatedwaittime","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"queueId","required":true,"type":"string"},{"name":"conversationId","in":"query","description":"conversationId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EstimatedWaitTimePredictions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueEstimatedwaittime"}},"/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime":{"get":{"tags":["Routing"],"summary":"Get Estimated Wait Time","description":"","operationId":"getRoutingQueueMediatypeEstimatedwaittime","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"queueId","required":true,"type":"string"},{"name":"mediaType","in":"path","description":"mediaType","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EstimatedWaitTimePredictions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueMediatypeEstimatedwaittime"}},"/api/v2/users/presences/purecloud/bulk":{"get":{"tags":["Presence"],"summary":"Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source","description":"","operationId":"getUsersPresencesPurecloudBulk","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UcUserPresence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.user.presences":"Only 50 user presences can be queried at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getUsersPresencesPurecloudBulk"}},"/api/v2/users/presences/{sourceId}/bulk":{"get":{"tags":["Presence"],"summary":"Get bulk user presences for a single presence source","description":"","operationId":"getUsersPresenceBulk","produces":["application/json"],"parameters":[{"name":"sourceId","in":"path","description":"The requested presence source ID.","required":true,"type":"string"},{"name":"id","in":"query","description":"A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UcUserPresence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.user.presences":"Only 50 user presences can be queried at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getUsersPresenceBulk"}},"/api/v2/users/presences/bulk":{"put":{"tags":["Presence"],"summary":"Update bulk user Presences","description":"","operationId":"putUsersPresencesBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"List of User presences","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/MutableUserPresence"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UserPresence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.user.presences":"Only 50 user presences can be updated at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","endpoint.does.not.support.on.queue":"The endpoint does not support updating to the ON_QUEUE presence"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["presence:userPresence:edit"]},"x-purecloud-method-name":"putUsersPresencesBulk"}},"/api/v2/presencedefinitions/{presenceId}":{"get":{"tags":["Presence"],"summary":"Get a Presence Definition. Apps should migrate to use GET /api/v2/presence/definitions/{definitionId} instead","description":"","operationId":"getPresencedefinition","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"},{"name":"localeCode","in":"query","description":"The locale code to fetch for the presence definition. Use ALL to fetch everything.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:view"]},"x-purecloud-method-name":"getPresencedefinition"},"put":{"tags":["Presence"],"summary":"Update a Presence Definition. Apps should migrate to use PUT /api/v2/presence/definitions/{definitionId} instead)","description":"","operationId":"putPresencedefinition","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The OrganizationPresence to update","required":true,"schema":{"$ref":"#/definitions/OrganizationPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:edit"]},"x-purecloud-method-name":"putPresencedefinition"},"delete":{"tags":["Presence"],"summary":"Delete a Presence Definition. Apps should migrate to use DELETE /api/v2/presence/definitions/{definitionId} instead","description":"","operationId":"deletePresencedefinition","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["presence"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:delete"]},"x-purecloud-method-name":"deletePresencedefinition"}},"/api/v2/presencedefinitions":{"get":{"tags":["Presence"],"summary":"Get an Organization's list of Presence Definitions. Apps should migrate to use GET /api/v2/presence/definitions instead","description":"","operationId":"getPresencedefinitions","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"deleted","in":"query","description":"Deleted query can be TRUE, FALSE or ALL","required":false,"type":"string","default":"false"},{"name":"localeCode","in":"query","description":"The locale code to fetch for each presence definition. Use ALL to fetch everything.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getPresencedefinitions"},"post":{"tags":["Presence"],"summary":"Create a Presence Definition. Apps should migrate to use POST /api/v2/presence/definitions instead","description":"","operationId":"postPresencedefinitions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Presence Definition to create","required":true,"schema":{"$ref":"#/definitions/OrganizationPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:add"]},"x-purecloud-method-name":"postPresencedefinitions"}},"/api/v2/presence/definitions/{definitionId}":{"get":{"tags":["Presence"],"summary":"Get a Presence Definition","description":"","operationId":"getPresenceDefinition","produces":["application/json"],"parameters":[{"name":"definitionId","in":"path","description":"Presence Definition ID","required":true,"type":"string"},{"name":"localeCode","in":"query","description":"The locale code to fetch for the presence definition. Use ALL to fetch everything.","required":false,"type":"string","enum":["ALL","he","fr","en_US","da","de","it","cs","es","fi","ar","ja","ko","nl","no","pl","pt_BR","pt_PT","ru","sv","th","tr","uk","zh_CN","zh_TW"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationpresence.organizationpresencenotfound":"The presence definition does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:view"]},"x-purecloud-method-name":"getPresenceDefinition"},"put":{"tags":["Presence"],"summary":"Update a Presence Definition","description":"","operationId":"putPresenceDefinition","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The updated Presence Definition","required":true,"schema":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},{"name":"definitionId","in":"path","description":"Presence Definition ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationpresence.organizationpresencenotfound":"The presence definition does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationpresence.localevaluesinvalid":"Invalid locale value","presenceservice.organizationpresence.musthaveatleastonelocalelabeldefined":"At least one locale label must be defined","presenceservice.organizationpresence.systempresencecannotbenull":"A valid system presence must be provided","presenceservice.organizationpresence.invaliddivisionid":"Invalid divisionId provided","presenceservice.organizationpresence.toomanyorganizationpresences":"Too many presence definitions. Please delete a definition and try again"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:edit"]},"x-purecloud-method-name":"putPresenceDefinition"},"delete":{"tags":["Presence"],"summary":"Delete a Presence Definition","description":"","operationId":"deletePresenceDefinition","produces":["application/json"],"parameters":[{"name":"definitionId","in":"path","description":"Presence Definition ID","required":true,"type":"string"}],"responses":{"204":{"description":"Presence Definition successfully deactivated."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationpresence.organizationpresencenotfound":"The presence definition does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["presence:presenceDefinition:delete","presence:presenceDefinition:edit"]},"x-purecloud-method-name":"deletePresenceDefinition"}},"/api/v2/presence/definitions":{"get":{"tags":["Presence"],"summary":"Get a list of Presence Definitions","description":"","operationId":"getPresenceDefinitions","produces":["application/json"],"parameters":[{"name":"deactivated","in":"query","description":"Deactivated query can be TRUE or FALSE","required":false,"type":"string","default":"false"},{"name":"divisionId","in":"query","description":"One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"localeCode","in":"query","description":"The locale code to fetch for the presence definition. Use ALL to fetch everything.","required":false,"type":"string","enum":["ALL","he","fr","en_US","da","de","it","cs","es","fi","ar","ja","ko","nl","no","pl","pt_BR","pt_PT","ru","sv","th","tr","uk","zh_CN","zh_TW"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceDefinitionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:view"]},"x-purecloud-method-name":"getPresenceDefinitions"},"post":{"tags":["Presence"],"summary":"Create a Presence Definition","description":"","operationId":"postPresenceDefinitions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Presence Definition to create","required":true,"schema":{"$ref":"#/definitions/OrganizationPresenceDefinition"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationpresence.localevaluesinvalid":"Invalid locale value","presenceservice.organizationpresence.musthaveatleastonelocalelabeldefined":"At least one locale label must be defined","presenceservice.organizationpresence.systempresencecannotbenull":"A valid system presence must be provided","presenceservice.organizationpresence.invaliddivisionid":"Invalid divisionId provided","presenceservice.organizationpresence.toomanyorganizationpresences":"Too many presence definitions. Please delete a definition and try again"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:add"]},"x-purecloud-method-name":"postPresenceDefinitions"}},"/api/v2/presence/settings":{"get":{"tags":["Presence"],"summary":"Get the presence settings","description":"","operationId":"getPresenceSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PresenceSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:settings:view"]},"x-purecloud-method-name":"getPresenceSettings"},"put":{"tags":["Presence"],"summary":"Update the presence settings","description":"","operationId":"putPresenceSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Presence Settings","required":true,"schema":{"$ref":"#/definitions/PresenceSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PresenceSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationconfiguration.invalidrestoretimemilliseconds":"Restore time value out of bounds","presenceservice.organizationconfiguration.restorepresenceconfigurationnotprovided":"A restore configuration object must be provided"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:settings:edit"]},"x-purecloud-method-name":"putPresenceSettings"}},"/api/v2/presence/sources/{sourceId}":{"get":{"tags":["Presence"],"summary":"Get a Presence Source","description":"","operationId":"getPresenceSource","produces":["application/json"],"parameters":[{"name":"sourceId","in":"path","description":"Presence Source ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Source"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.sourcenotfound":"The source was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:source:view"]},"x-purecloud-method-name":"getPresenceSource"},"put":{"tags":["Presence"],"summary":"Update a Presence Source","description":"","operationId":"putPresenceSource","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The updated Presence Source","required":true,"schema":{"$ref":"#/definitions/Source"}},{"name":"sourceId","in":"path","description":"Presence Source ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Source"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.sourcenotfound":"The source was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.namecannotbeblank":"A name must be provided for a source","presenceservice.source.descriptiontoolong":"Description exceeded max character count","presenceservice.source.systemsourcescannotbeupdated":"A source of type 'system' cannot be updated","presenceservice.source.nametoolong":"Name exceeded max character count","presenceservice.source.systemsourcescannotbedeleted":"A source of type 'system' cannot be deleted","presenceservice.source.toomanyactivesources":"Max number of active sources reached"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:source:edit"]},"x-purecloud-method-name":"putPresenceSource"},"delete":{"tags":["Presence"],"summary":"Delete a Presence Source","description":"","operationId":"deletePresenceSource","produces":["application/json"],"parameters":[{"name":"sourceId","in":"path","description":"Presence Source ID","required":true,"type":"string"}],"responses":{"204":{"description":"Presence source successfully deactivated."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.systemsourcescannotbedeleted":"A source of type 'system' cannot be deleted"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["presence:source:delete","presence:source:edit"]},"x-purecloud-method-name":"deletePresenceSource"}},"/api/v2/presence/sources":{"get":{"tags":["Presence"],"summary":"Get a list of Presence Sources","description":"","operationId":"getPresenceSources","produces":["application/json"],"parameters":[{"name":"deactivated","in":"query","description":"Deactivated query can be TRUE or FALSE","required":false,"type":"string","default":"false"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SourceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:source:view"]},"x-purecloud-method-name":"getPresenceSources"},"post":{"tags":["Presence"],"summary":"Create a Presence Source","description":"","operationId":"postPresenceSources","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Presence Source to create","required":true,"schema":{"$ref":"#/definitions/Source"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Source"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.namecannotbeblank":"A name must be provided for a source","presenceservice.source.descriptiontoolong":"Description exceeded max character count","presenceservice.source.nametoolong":"Name exceeded max character count","presenceservice.source.toomanyactivesources":"Max number of active sources reached"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:source:add"]},"x-purecloud-method-name":"postPresenceSources"}},"/api/v2/systempresences":{"get":{"tags":["Presence"],"summary":"Get the list of SystemPresences","description":"","operationId":"getSystempresences","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/SystemPresence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getSystempresences"}},"/api/v2/users/{userId}/presences/purecloud":{"get":{"tags":["Presence"],"summary":"Get a user's Genesys Cloud presence.","description":"Get the default Genesys Cloud user presence source PURECLOUD","operationId":"getUserPresencesPurecloud","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getUserPresencesPurecloud"},"patch":{"tags":["Presence"],"summary":"Patch a Genesys Cloud user's presence","description":"The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.","operationId":"patchUserPresencesPurecloud","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"in":"body","name":"body","description":"User presence","required":true,"schema":{"$ref":"#/definitions/UserPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presence.not.authorized.update.other.user.presence":"Not authorized to update another user's presence","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","presence.not.authorized.update.on.queue":"Not authorized to update presence to ON_QUEUE","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.conflict":"A previous update request has not yet completed"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-purecloud-method-name":"patchUserPresencesPurecloud"}},"/api/v2/users/{userId}/presences/{sourceId}":{"get":{"tags":["Presence"],"summary":"Get a user's Presence","description":"Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources. This endpoint does not support registered presence sources.","operationId":"getUserPresence","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Presence source ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getUserPresence"},"patch":{"tags":["Presence"],"summary":"Patch a user's Presence","description":"Patch a user's presence for the specified source that is not specifically listed. This endpoint does not support registered presence sources. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.","operationId":"patchUserPresence","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Presence source ID","required":true,"type":"string"},{"in":"body","name":"body","description":"User presence","required":true,"schema":{"$ref":"#/definitions/UserPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presence.not.authorized.update.other.user.presence":"Not authorized to update another user's presence","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","presence.not.authorized.update.on.queue":"Not authorized to update presence to ON_QUEUE","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.conflict":"A previous update request has not yet completed"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-purecloud-method-name":"patchUserPresence"}},"/api/v2/presence/users/{userId}/primarysource":{"get":{"tags":["Presence"],"summary":"Get a user's Primary Presence Source","description":"","operationId":"getPresenceUserPrimarysource","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPrimarySource"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:userPrimarySource:view"]},"x-purecloud-method-name":"getPresenceUserPrimarysource"},"put":{"tags":["Presence"],"summary":"Update a user's Primary Presence Source","description":"","operationId":"putPresenceUserPrimarysource","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Primary Source","required":true,"schema":{"$ref":"#/definitions/UserPrimarySource"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPrimarySource"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:userPrimarySource:edit"]},"x-purecloud-method-name":"putPresenceUserPrimarysource"}},"/api/v2/processautomation/triggers/topics/{topicName}/test":{"post":{"tags":["Process Automation"],"summary":"Test the matching of all organization Triggers on given topic using provided event body","description":"","operationId":"postProcessautomationTriggersTopicTest","produces":["application/json"],"parameters":[{"name":"topicName","in":"path","description":"topicName","required":true,"type":"string"},{"in":"body","name":"body","description":"eventBody","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestModeEventResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:test"]},"x-purecloud-method-name":"postProcessautomationTriggersTopicTest"}},"/api/v2/processautomation/triggers/topics":{"get":{"tags":["Process Automation"],"summary":"Get topics available for organization","description":"","operationId":"getProcessautomationTriggersTopics","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TopicCursorEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation","process-automation:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:edit","processautomation:trigger:view"]},"x-purecloud-method-name":"getProcessautomationTriggersTopics"}},"/api/v2/processautomation/triggers/{triggerId}":{"get":{"tags":["Process Automation"],"summary":"Retrieve a single Trigger matching id","description":"","operationId":"getProcessautomationTrigger","produces":["application/json"],"parameters":[{"name":"triggerId","in":"path","description":"triggerId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trigger"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation","process-automation:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:edit","processautomation:trigger:view"]},"x-purecloud-method-name":"getProcessautomationTrigger"},"put":{"tags":["Process Automation"],"summary":"Update a Trigger","description":"","operationId":"putProcessautomationTrigger","produces":["application/json"],"parameters":[{"name":"triggerId","in":"path","description":"triggerId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input to update Trigger. (topicName cannot be updated, a new trigger must be created to use a new topicName)","required":true,"schema":{"$ref":"#/definitions/UpdateTriggerRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trigger"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:edit"]},"x-purecloud-method-name":"putProcessautomationTrigger"},"delete":{"tags":["Process Automation"],"summary":"Delete a Trigger","description":"","operationId":"deleteProcessautomationTrigger","produces":["application/json"],"parameters":[{"name":"triggerId","in":"path","description":"triggerId","required":true,"type":"string"}],"responses":{"204":{"description":"Delete was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:delete"]},"x-purecloud-method-name":"deleteProcessautomationTrigger"}},"/api/v2/processautomation/triggers/{triggerId}/test":{"post":{"tags":["Process Automation"],"summary":"Test the matching of a Trigger based on provided event body","description":"","operationId":"postProcessautomationTriggerTest","produces":["application/json"],"parameters":[{"name":"triggerId","in":"path","description":"triggerId","required":true,"type":"string"},{"in":"body","name":"body","description":"eventBody","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestModeResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:test"]},"x-purecloud-method-name":"postProcessautomationTriggerTest"}},"/api/v2/processautomation/triggers":{"get":{"tags":["Process Automation"],"summary":"Retrieves all triggers, optionally filtered by query parameters.","description":"","operationId":"getProcessautomationTriggers","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"topicName","in":"query","description":"Topic name(s). Separated by commas","required":false,"type":"string"},{"name":"enabled","in":"query","description":"Boolean indicating desired enabled state of triggers","required":false,"type":"boolean"},{"name":"hasDelayBy","in":"query","description":"Boolean to filter based on delayBySeconds being set in triggers. Default returns all, true returns only those with delayBySeconds set, false returns those without delayBySeconds set.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TriggerEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation","process-automation:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:edit","processautomation:trigger:view"]},"x-purecloud-method-name":"getProcessautomationTriggers"},"post":{"tags":["Process Automation"],"summary":"Create a Trigger","description":"","operationId":"postProcessautomationTriggers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Input used to create a Trigger.","required":true,"schema":{"$ref":"#/definitions/CreateTriggerRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trigger"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:add"]},"x-purecloud-method-name":"postProcessautomationTriggers"}},"/api/v2/quality/agents/activity":{"get":{"tags":["Quality"],"summary":"Gets a list of Agent Activities","description":"Each item on the list shows one agent's evaluation activity comprised of the number of evaluations and the highest, average, and lowest standard and critical scores, as well as a sub list showing the number and average score of evaluations for each evaluator for that agent. evaluatorUserId, startTime, and endTime are all filtering criteria. If specified, the only evaluations used to compile the agent activity response will be ones that match the filtering criteria. agentUserId, name, group, and agentTeamId are all agent selection criteria. criteria. If one or more agent selection criteria are specified, then the returned activity will include users that match the criteria even if those users did not have any agent activity or evaluations that do not match any filtering criteria. If no agent selection criteria are specified but an evaluatorUserId is, then the returned activity will be only for those agents that had evaluations where the evaluator is the evaluatorUserId. If no agent selection criteria are specified and no evaluatorUserId is specified, then the returned activity will be for all users","operationId":"getQualityAgentsActivity","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"startTime","in":"query","description":"Start time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"End time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"agentUserId","in":"query","description":"user id of agent requested","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"evaluatorUserId","in":"query","description":"user id of the evaluator","required":false,"type":"string"},{"name":"name","in":"query","description":"name","required":false,"type":"string"},{"name":"group","in":"query","description":"group id","required":false,"type":"string"},{"name":"agentTeamId","in":"query","description":"team id of agents requested","required":false,"type":"string"},{"name":"formContextId","in":"query","description":"shared id between form versions","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentActivityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.evaluation.view.permission.check.failed":"Failed to check required view permission.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view"]},"x-purecloud-method-name":"getQualityAgentsActivity"}},"/api/v2/recording/batchrequests/{jobId}":{"get":{"tags":["Recording"],"summary":"Get the status and results for a batch request job, only the user that submitted the job may retrieve results. 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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-purecloud-method-name":"getRecordingBatchrequest"}},"/api/v2/recording/batchrequests":{"post":{"tags":["Recording"],"summary":"Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration.","description":"","operationId":"postRecordingBatchrequests","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Job submission criteria","required":true,"schema":{"$ref":"#/definitions/BatchDownloadJobSubmission"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BatchDownloadJobSubmissionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"batch.download.too.many.items":"Too many items requested, max 100 allowed","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","batch.download.bad.request":"Request list is required and must not be empty","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"postRecordingBatchrequests"}},"/api/v2/quality/calibrations/{calibrationId}":{"get":{"tags":["Quality"],"summary":"Get a calibration by id. Requires either calibrator id or conversation id","description":"","operationId":"getQualityCalibration","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"name":"calibratorId","in":"query","description":"calibratorId","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"conversationId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","quality.calibration.view.permission.check.failed":"calibration view permission check failed","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:view"]},"x-purecloud-method-name":"getQualityCalibration"},"put":{"tags":["Quality"],"summary":"Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex","description":"","operationId":"putQualityCalibration","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Calibration","required":true,"schema":{"$ref":"#/definitions/Calibration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.already.exists":"evaluation already exists","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","quality.calibration.expert.evaluator.not.quality.evaluator":"expert evaluator does not have evaluator permissions","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","quality.calibration.update.permission.check.failed":"calibration update permission check failed","quality.calibration.scoring.index.conversation.mismatch":"calibration scoring index did not match the expected value.","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:edit"]},"x-purecloud-method-name":"putQualityCalibration"},"delete":{"tags":["Quality"],"summary":"Delete a calibration by id.","description":"","operationId":"deleteQualityCalibration","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"name":"calibratorId","in":"query","description":"calibratorId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","quality.calibration.delete.permission.check.failed":"calibration delete permission check failed"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:delete"]},"x-purecloud-method-name":"deleteQualityCalibration"}},"/api/v2/quality/calibrations":{"get":{"tags":["Quality"],"summary":"Get the list of calibrations","description":"NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch.","operationId":"getQualityCalibrations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"conversation id","required":false,"type":"string"},{"name":"startTime","in":"query","description":"Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"calibratorId","in":"query","description":"user id of calibrator","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CalibrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:view"]},"x-purecloud-method-name":"getQualityCalibrations"},"post":{"tags":["Quality"],"summary":"Create a calibration","description":"","operationId":"postQualityCalibrations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"calibration","required":true,"schema":{"$ref":"#/definitions/CalibrationCreate"}},{"name":"expand","in":"query","description":"calibratorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.calibration.no.evaluation.form.or.context.id":"evaluation form or context id missing","bad.request":"The request could not be understood by the server due to malformed syntax.","qm.calibration.create.error.no.evaluators":"Failed to create calibration because the specified evaluators do not exist.","quality.evaluation.agent.doesnt.have.participate.permission":"Agent does not have evaluation participate permission","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.evaluation.form.context.doesnt.exist":"Evaluation form context doesn't exist","quality.calibration.scoring.index.evaluator.must.match.calibrator.or.expert.evaluator":"scoring index evaluator must be a calibrator or expert evaluator","qm.calibration.create.error.no.agent":"Failed to create calibration because the conversation has no agent user","constraint.validation":"%s","quality.calibration.existing.evaluation.not.finished":"Existing evaluation is not finished for calibration","quality.calibration.expert.evaluator.not.quality.evaluator":"expert evaluator does not have evaluator permissions","quality.calibration.no.existing.evaluation.for.evaluationid":"no evaluation found for existing evaluation","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","quality.calibration.contextid.doesnt.match.evaluation.contextid":"Calibration contextId doesn't match the evaluation contextId","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","quality.conversation.doesnt.exist":"unable to find specified conversation","qm.calibration.create.error.no.conversation":"Failed to create calibration because the specified conversation does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.calibration.create.permission.check.failed":"Calibration create permission check failed","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:add"]},"x-purecloud-method-name":"postQualityCalibrations"}},"/api/v2/quality/conversations/audits/query":{"post":{"tags":["Quality"],"summary":"Create audit query execution","description":"","operationId":"postQualityConversationsAuditsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/QMAuditQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QualityAuditQueryExecutionStatusResponse"}},"202":{"description":"Accepted - Query execution is accepted.","schema":{"$ref":"#/definitions/QualityAuditQueryExecutionStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:interactionDetails:view"]},"x-purecloud-method-name":"postQualityConversationsAuditsQuery"}},"/api/v2/quality/conversations/audits/query/{transactionId}":{"get":{"tags":["Quality"],"summary":"Get status of audit query execution","description":"","operationId":"getQualityConversationsAuditsQueryTransactionId","produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"Transaction ID","required":true,"type":"string"}],"responses":{"200":{"description":"Query execution completed.","schema":{"$ref":"#/definitions/QualityAuditQueryExecutionStatusResponse"}},"202":{"description":"In progress - Query execution is in progress.","schema":{"$ref":"#/definitions/QualityAuditQueryExecutionStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:interactionDetails:view"]},"x-purecloud-method-name":"getQualityConversationsAuditsQueryTransactionId"}},"/api/v2/quality/conversations/audits/query/{transactionId}/results":{"get":{"tags":["Quality"],"summary":"Get results of audit query","description":"","operationId":"getQualityConversationsAuditsQueryTransactionIdResults","produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"Transaction ID","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["user"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QualityAuditQueryExecutionResultsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:interactionDetails:view"]},"x-purecloud-method-name":"getQualityConversationsAuditsQueryTransactionIdResults"}},"/api/v2/recordings/deletionprotection":{"post":{"tags":["Recording"],"summary":"Get a list of conversations with protected recordings","description":"","operationId":"postRecordingsDeletionprotection","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"conversationIds","required":true,"schema":{"$ref":"#/definitions/ConversationDeletionProtectionQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/AddressableEntityRef"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.conversation.id.not.uuid":"Request needs recording conversation ID not UUID.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.conversation.not.found":"Recording conversation not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings:readonly"]}],"x-purecloud-method-name":"postRecordingsDeletionprotection"},"put":{"tags":["Recording"],"summary":"Apply or revoke recording protection for conversations","description":"","operationId":"putRecordingsDeletionprotection","produces":["application/json"],"parameters":[{"name":"protect","in":"query","description":"Check for apply, uncheck for revoke (each action requires the respective permission)","required":false,"type":"boolean","default":true},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ConversationDeletionProtectionQuery"}}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","recording.empty.payload":"Recording payload was empty.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.conversation.not.found":"Recording conversation not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:deletionProtection:apply","recording:deletionProtection:revoke"]},"x-purecloud-method-name":"putRecordingsDeletionprotection"}},"/api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}":{"get":{"tags":["Quality"],"summary":"Get an evaluation","description":"","operationId":"getQualityConversationEvaluation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"evaluationId","in":"path","description":"evaluationId","required":true,"type":"string"},{"name":"expand","in":"query","description":"agent, assignee, evaluator, evaluationForm","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.evaluation.view.permission.check.failed":"Failed to check required view permission.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view","quality:evaluation:assign","quality:evaluation:release"]},"x-purecloud-method-name":"getQualityConversationEvaluation"},"put":{"tags":["Quality"],"summary":"Update an evaluation","description":"The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation. authorizedActions is not returned for this PUT request, and is only returned for GET requests to this endpoint.","operationId":"putQualityConversationEvaluation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"evaluationId","in":"path","description":"evaluationId","required":true,"type":"string"},{"in":"body","name":"body","description":"evaluation","required":true,"schema":{"$ref":"#/definitions/Evaluation"}},{"name":"expand","in":"query","description":"evaluatorId, evaluationForm, assignee, evaluator","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.evaluator.doesnt.exist":"Evaluator doesn't exist","quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","quality.evaluation.cannot.change.evaluation.form":"Cannot change evaluation form","bad.request":"The request could not be understood by the server due to malformed syntax.","quality.scoring.question.not.in.evaluation.form":"Submitted answers contained reference to a question which is not in the evaluation form","quality.evaluation.cannot.change.evaluationid":"Cannot change evaluationId","quality.evaluation.agent.doesnt.have.participate.permission":"Agent doesn't have participate permission.","constraint.validation":"%s","qm.evaluation.create.error.no.agent":"Need an agent user on the conversation to create an evaluation","quality.evaluation.invalid.state.non.pending.to.pending":"Invalid state, non pending to pending","quality.evaluation.agent.doesnt.exist":"Agent doesn't exist","quality.evaluation.cannot.have.different.assignee.and.evaluator":"Evaluation has an invalid combination of evaluator & assignee ids","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","quality.evaluation.no.answers.for.state":"No answers were found for state.","quality.evaluation.cannot.change.conversation":"Cannot change conversation","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.evaluation.assignee.not.provided":"Evaluation has missing assignee user","quality.evaluation.cannot.assign.released.evaluation":"Evaluation cannot be assigned in completed & released state.","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","quality.evaluation.calibration.and.release.date.both.set":"Calibration and release date both set","quality.evaluation.cannot.change.calibration":"Cannot change calibration","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","quality.evaluation.required.answers.for.state":"Answers are required for state","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.scoring.answer.not.in.evaluation.form":"Submitted answers contained reference to an answer which is not in the evaluation form","quality.scoring.question.group.not.in.evaluation.form":"Submitted answers contained reference to a question group which is not in the evaluation form","quality.evaluation.too.old.to.score":"Evaluation is too old to score"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","quality.evaluation.update.permission.check.failed":"Missing evaluation update permission","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","quality.evaluation.cannot.change.assignee":"User has insufficient permissions to update assignee","quality.evaluation.assignee.permission.check.failed":"Assignee has insufficient permissions","quality.evaluation.cannot.update.private.comments":"User has insufficient permissions to update private comments"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.no.answer.for.state":"No answers for state","quality.evaluation.form.doesnt.exist":"Evaluation form doesn't exist","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:edit","quality:evaluation:editScore","quality:evaluation:editAgentSignoff"]},"x-purecloud-method-name":"putQualityConversationEvaluation"},"delete":{"tags":["Quality"],"summary":"Delete an evaluation","description":"","operationId":"deleteQualityConversationEvaluation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"evaluationId","in":"path","description":"evaluationId","required":true,"type":"string"},{"name":"expand","in":"query","description":"evaluatorId, evaluationForm","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","quality.evaluation.delete.permission.check.failed":"Failed evaluation deletion permission check","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.form.doesnt.exist":"Evaluation form doesn't exist","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:delete"]},"x-purecloud-method-name":"deleteQualityConversationEvaluation"}},"/api/v2/quality/conversations/{conversationId}/evaluations":{"post":{"tags":["Quality"],"summary":"Create an evaluation","description":"","operationId":"postQualityConversationEvaluations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"evaluation","required":true,"schema":{"$ref":"#/definitions/EvaluationCreateBody"}},{"name":"expand","in":"query","description":"evaluatorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.evaluator.doesnt.exist":"Evaluator doesn't exist","quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","bad.request":"The request could not be understood by the server due to malformed syntax.","quality.scoring.question.not.in.evaluation.form":"Submitted answers contained reference to a question which is not in the evaluation form","quality.evaluation.agent.doesnt.have.participate.permission":"Agent doesn't have required permission to participate","constraint.validation":"%s","qm.evaluation.create.error.no.agent":"Need an agent user on the conversation to create an evaluation","quality.evaluation.answers.for.pending.state":"Evaluation answers for pending state.","quality.evaluation.agent.doesnt.exist":"Agent user does not exist","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","quality.evaluation.already.exists":"An evaluation for this conversation already exists","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.evaluation.for.pending.state":"Answers required for pending state","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","quality.evaluation.no.answers.for.finished.state":"No answers for finished state","quality.evaluation.create.limit.exceeded.for.agent":"Evaluation creation limit exceeded for agent","quality.evaluation.form.doesnt.exist":"Evaluation form doesn't exist","qm.evaluation.create.error.no.evaluator":"Submitted evaluation missing evaluator","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.scoring.answer.not.in.evaluation.form":"Submitted answers contained reference to an answer which is not in the evaluation form","quality.conversation.doesnt.exist":"Quality conversation does not exist.","quality.scoring.question.group.not.in.evaluation.form":"Submitted answers contained reference to a question group which is not in the evaluation form","quality.evaluation.form.not.published":"Evaluation form is not published"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","quality.evaluation.create.permission.check.failed":"Failed evaluation creation permission check"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:add"]},"x-purecloud-method-name":"postQualityConversationEvaluations"}},"/api/v2/quality/conversations/{conversationId}/surveys":{"get":{"tags":["Quality"],"summary":"Get the surveys for a conversation","description":"","operationId":"getQualityConversationSurveys","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Survey"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.query.invalid.conversation":"Query conversation was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:survey:view"]},"x-purecloud-method-name":"getQualityConversationSurveys"}},"/api/v2/quality/evaluations/aggregates/query/me":{"post":{"tags":["Quality"],"summary":"Query for evaluation aggregates for the current user","description":"","operationId":"postQualityEvaluationsAggregatesQueryMe","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/EvaluationAggregationQueryMe"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-purecloud-method-name":"postQualityEvaluationsAggregatesQueryMe"}},"/api/v2/quality/forms/evaluations/{formId}":{"get":{"tags":["Quality"],"summary":"Get an evaluation form","description":"","operationId":"getQualityFormsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","evaluation.not.found":"Evaluation form not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormsEvaluation"},"put":{"tags":["Quality"],"summary":"Update an evaluation form.","description":"","operationId":"putQualityFormsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.evaluator.doesnt.exist":"One or more assignees do not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","composer.form.name.too.long":"Evaluation form name is too long","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","quality.evaluation.config.evaluator.no.permission":"One or more assignees do not have the required permissions","evaluation.form.invalid":"Evaluation form is not valid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","composer.form.too.many.questions":"Evaluation form has too many questions","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.name.conflict":"Evaluation form named has a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:edit"]},"x-purecloud-method-name":"putQualityFormsEvaluation"},"delete":{"tags":["Quality"],"summary":"Delete an evaluation form.","description":"","operationId":"deleteQualityFormsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.cannot.be.deleted":"Cannot delete evaluation because it has already been published."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:delete"]},"x-purecloud-method-name":"deleteQualityFormsEvaluation"}},"/api/v2/quality/forms/evaluations/{formId}/versions":{"get":{"tags":["Quality"],"summary":"Gets all the revisions for a specific evaluation.","description":"","operationId":"getQualityFormsEvaluationVersions","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormsEvaluationVersions"}},"/api/v2/quality/forms/evaluations/bulk/contexts":{"get":{"tags":["Quality"],"summary":"Retrieve a list of the latest published evaluation form versions by context ids","description":"","operationId":"getQualityFormsEvaluationsBulkContexts","produces":["application/json"],"parameters":[{"name":"contextId","in":"query","description":"A comma-delimited list of valid evaluation form context ids","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/EvaluationFormResponse"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.no.ids.bulk.fetch":"You must specify at least 1 id","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","evaluation.too.many.ids.bulk.fetch":"You may only specify 100 or less ids","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"You are not authorized to perform the requested action","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormsEvaluationsBulkContexts"}},"/api/v2/quality/forms/evaluations":{"get":{"tags":["Quality"],"summary":"Get the list of evaluation forms","description":"By default, \"published\" field is always returned as false for all evaluation forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding evaluation form.\nIn addition, \"questionGroups\", the detailed information about evaluation form, is not returned. We will enhance this field in a future release.","operationId":"getQualityFormsEvaluations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"expand","in":"query","description":"If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions","required":false,"type":"string","enum":["publishHistory"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Order to sort results, either asc or desc","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormsEvaluations"},"post":{"tags":["Quality"],"summary":"Create an evaluation form.","description":"","operationId":"postQualityFormsEvaluations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.evaluator.doesnt.exist":"One or more assignees do not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","composer.form.name.too.long":"Evaluation form name is too long","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","quality.evaluation.config.evaluator.no.permission":"One or more assignees do not have the required permissions","evaluation.form.invalid":"Evaluation form is not valid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","composer.form.too.many.questions":"Evaluation form has too many questions","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.name.conflict":"Evaluation form named has a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityFormsEvaluations"}},"/api/v2/quality/evaluations/query":{"get":{"tags":["Quality"],"summary":"Queries Evaluations and returns a paged list","description":"Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to 'Never Release' are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date. NOTE: The count for total and pageCount might not be accurate when querying for a large number of evaluations. nextUri, if present, will indicate that there are more evaluations to fetch. The evaluation entities contained in the response might only contain a subset of all the properties listed below. It is often because a given property's value has not yet been populated or is not applicable in the current state of the evaluation. It might also be because the missing property in the response was not requested by the user.","operationId":"getQualityEvaluationsQuery","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"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"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.query.invalid.conversation":"Quality query has invalid conversation.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.query.invalid.user":"User does not exist","quality.query.spec.one.of.agent.or.evaluator.or.assignee.or.conversation":"Quality query needs one agent, evaluator, or assignee, or conversation.","quality.query.spec.one.of.agent.or.evaluator.or.assignee.or.conversation.or.team":"Quality query needs one agent, evaluator, assignee, conversation, agent team.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.backend.service.timeout":"Backend service timeout","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view"]},"x-purecloud-method-name":"getQualityEvaluationsQuery"}},"/api/v2/quality/evaluations/scoring":{"post":{"tags":["Quality"],"summary":"Score evaluation","description":"","operationId":"postQualityEvaluationsScoring","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"evaluationAndScoringSet","required":true,"schema":{"$ref":"#/definitions/EvaluationFormAndScoringSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationScoringSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","bad.request":"The request could not be understood by the server due to malformed syntax.","quality.scoring.question.not.in.evaluation.form":"Submitted answers contained reference to a question which is not in the evaluation form","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","quality.scoring.answer.not.in.evaluation.form":"Submitted answers contained reference to an answer which is not in the evaluation form","general.bad.request":"Request is badly formed.","quality.scoring.question.group.not.in.evaluation.form":"Submitted answers contained reference to a question group which is not in the evaluation form","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-purecloud-method-name":"postQualityEvaluationsScoring"}},"/api/v2/quality/evaluators/activity":{"get":{"tags":["Quality"],"summary":"Get an evaluator activity","description":"","operationId":"getQualityEvaluatorsActivity","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"startTime","in":"query","description":"The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"name","in":"query","description":"Evaluator name","required":false,"type":"string"},{"name":"permission","in":"query","description":"permission strings","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"group","in":"query","description":"group id","required":false,"type":"string"},{"name":"agentTeamId","in":"query","description":"team id of agents to be considered","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluatorActivityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"qmevaluatoractivity.search.too.many.results":"Too many results in evaluator activity query; user needs to enter more characters for name search","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","qmevaluatoractivity.pagenum.too.big":"Page number too large in evaluator activity query","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","qmevaluatoractivity.pagenum.too.small":"Page number too small in evaluator activity query; cannot be < 1"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.evaluation.view.permission.check.failed":"Failed to check required view permission.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view"]},"x-purecloud-method-name":"getQualityEvaluatorsActivity"}},"/api/v2/orphanrecordings/{orphanId}/media":{"get":{"tags":["Recording"],"summary":"Gets the media of a single orphan recording","description":"A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.","operationId":"getOrphanrecordingMedia","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"]},{"name":"emailFormatId","in":"query","description":"The desired media format when downloading an email recording.","required":false,"type":"string","default":"EML","enum":["EML","NONE"]},{"name":"chatFormatId","in":"query","description":"The desired media format when downloading a chat recording.","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"]},{"name":"messageFormatId","in":"query","description":"The desired media format when downloading a message recording.","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"]},{"name":"download","in":"query","description":"requesting a download format of the recording","required":false,"type":"boolean","default":false,"enum":["true","false"]},{"name":"fileName","in":"query","description":"the name of the downloaded fileName","required":false,"type":"string"},{"name":"locale","in":"query","description":"The locale for the requested file when downloading, as an ISO 639-1 code","required":false,"type":"string"},{"name":"mediaFormats","in":"query","description":"All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recording"}},"202":{"description":"Accepted - Transcoding orphan media"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:view"]},"x-purecloud-method-name":"getOrphanrecordingMedia"}},"/api/v2/orphanrecordings/{orphanId}":{"get":{"tags":["Recording"],"summary":"Gets a single orphan recording","description":"","operationId":"getOrphanrecording","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:view"]},"x-purecloud-method-name":"getOrphanrecording"},"put":{"tags":["Recording"],"summary":"Updates an orphan recording to a regular recording with retention values","description":"If this operation is successful the orphan will no longer exist. It will be replaced by the resulting recording in the response. This replacement recording is accessible by the normal Recording api.","operationId":"putOrphanrecording","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/OrphanUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.orphan.retention.data.invalid":"The provided dates in the payload were invalid.","recording.orphan.unknown.conversation":"The provided conversation in the payload doesn't exist.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","recording.recording.analytics.retention.violation":"The provided delete date exceeds the limit imposed by the analytics retention settings.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.orphan.edit.permission.check.failed":"Requesting user lacks permission to perform this api operation."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:edit"]},"x-purecloud-method-name":"putOrphanrecording"},"delete":{"tags":["Recording"],"summary":"Deletes a single orphan recording","description":"","operationId":"deleteOrphanrecording","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:delete"]},"x-purecloud-method-name":"deleteOrphanrecording"}},"/api/v2/orphanrecordings":{"get":{"tags":["Recording"],"summary":"Gets all orphan recordings","description":"","operationId":"getOrphanrecordings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"hasConversation","in":"query","description":"Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization.","required":false,"type":"boolean","default":false},{"name":"media","in":"query","description":"Filter resulting orphans based on their media type","required":false,"type":"string","enum":["Call","Screen"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecordingListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.orphan.view.permission.check.failed":"Failed to verify recording view permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:view"]},"x-purecloud-method-name":"getOrphanrecordings"}},"/api/v2/quality/publishedforms/evaluations/{formId}":{"get":{"tags":["Quality"],"summary":"Get the most recent published version of an evaluation form.","description":"","operationId":"getQualityPublishedformsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsEvaluation"}},"/api/v2/quality/publishedforms/evaluations":{"get":{"tags":["Quality"],"summary":"Get the published evaluation forms.","description":"","operationId":"getQualityPublishedformsEvaluations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"onlyLatestPerContext","in":"query","description":"onlyLatestPerContext","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsEvaluations"},"post":{"tags":["Quality"],"summary":"Publish an evaluation form.","description":"","operationId":"postQualityPublishedformsEvaluations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Publish request containing id of form to publish","required":true,"schema":{"$ref":"#/definitions/PublishForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.config.evaluator.no.permission":"One or more assignees do not have the required permissions","quality.evaluation.evaluator.doesnt.exist":"One or more assignees do not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityPublishedformsEvaluations"}},"/api/v2/quality/publishedforms/surveys/{formId}":{"get":{"tags":["Quality"],"summary":"Get the most recent published version of a survey form.","description":"","operationId":"getQualityPublishedformsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsSurvey"}},"/api/v2/quality/publishedforms/surveys":{"get":{"tags":["Quality"],"summary":"Get the published survey forms.","description":"","operationId":"getQualityPublishedformsSurveys","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"onlyLatestEnabledPerContext","in":"query","description":"onlyLatestEnabledPerContext","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsSurveys"},"post":{"tags":["Quality"],"summary":"Publish a survey form.","description":"","operationId":"postQualityPublishedformsSurveys","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/PublishForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:add"]},"x-purecloud-method-name":"postQualityPublishedformsSurveys"}},"/api/v2/conversations/{conversationId}/recordingmetadata/{recordingId}":{"get":{"tags":["Recording"],"summary":"Get metadata for a specific recording. Does not return playable media.","description":"","operationId":"getConversationRecordingmetadataRecordingId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingMetadata"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Failed to verify recording view permission.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.recordingsegment.view.permission.check.failed":"Failed to verify recording segment view permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","recording.recording.not.found":"Recording with recordingId was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"getConversationRecordingmetadataRecordingId"}},"/api/v2/conversations/{conversationId}/recordings/{recordingId}":{"get":{"tags":["Recording"],"summary":"Gets a specific recording.","description":"","operationId":"getConversationRecording","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"]},{"name":"emailFormatId","in":"query","description":"The desired media format when downloading an email recording. Valid values:EML,NONE","required":false,"type":"string","default":"EML","enum":["EML","NONE"]},{"name":"chatFormatId","in":"query","description":"The desired media format when downloading a chat recording. Valid values:ZIP,NONE ","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"]},{"name":"messageFormatId","in":"query","description":"The desired media format when downloading a message recording. Valid values:ZIP,NONE","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"]},{"name":"download","in":"query","description":"requesting a download format of the recording. Valid values:true,false","required":false,"type":"boolean","default":false,"enum":["true","false"]},{"name":"fileName","in":"query","description":"the name of the downloaded fileName","required":false,"type":"string"},{"name":"locale","in":"query","description":"The locale for the requested file when downloading, as an ISO 639-1 code","required":false,"type":"string"},{"name":"mediaFormats","in":"query","description":"All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"202":{"description":"Success - recording is transcoding","schema":{"$ref":"#/definitions/Recording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.query.invalid.conversation":"The conversation query was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Failed to verify recording view permission.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.recordingsegment.view.permission.check.failed":"Failed to verify recording segment view permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"getConversationRecording"},"put":{"tags":["Recording"],"summary":"Updates the retention records on a recording.","description":"Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. The recording:recording:view permission is required for the recording, as well as either the recording:recording:editRetention or recording:screenRecording:editRetention permissions depending on the type of recording.","operationId":"putConversationRecording","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"recording","required":true,"schema":{"$ref":"#/definitions/Recording"}},{"name":"clearExport","in":"query","description":"Whether to clear the pending export for the recording","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","recording.not.archivable":"Recording has been deleted or is still uploading","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.invalid.json":"Recording request contains invalid JSON","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","recording.recording.edit.retention.permission.check.failed":"Failed to verify recording edit retention permission.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.recording.restore.permission.check.failed":"improper permissions found when attempting to restore recordings"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.not.archivable":"Recording is not achievable","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recording:editRetention","recording:screenRecording:editRetention"]},"x-purecloud-method-name":"putConversationRecording"}},"/api/v2/conversations/{conversationId}/recordingmetadata":{"get":{"tags":["Recording"],"summary":"Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if either recording:recording:view or recording:annotation:view permission is missing.","description":"","operationId":"getConversationRecordingmetadata","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/RecordingMetadata"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Request forbidden due to recording view permissions check failing.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.recordingsegment.view.permission.check.failed":"Request forbidden due to recording segment view permissions check failing."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.not.found":"Conversation with specified conversationId was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"getConversationRecordingmetadata"}},"/api/v2/conversations/{conversationId}/recordings":{"get":{"tags":["Recording"],"summary":"Get all of a Conversation's Recordings.","description":"","operationId":"getConversationRecordings","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"maxWaitMs","in":"query","description":"The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value.","required":false,"type":"integer","default":5000,"format":"int32"},{"name":"formatId","in":"query","description":"The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"]},{"name":"mediaFormats","in":"query","description":"All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Recording"}}},"202":{"description":"Success - recording is transcoding"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.query.invalid.conversation":"Quality query has invalid conversation.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"The recording:recording:view permission is required.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.recordingsegment.view.permission.check.failed":"The recording:recordingSegment:view permission is required."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.not.found":"A conversation for the provided conversationId was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"getConversationRecordings"}},"/api/v2/recordings/retention/query":{"get":{"tags":["Recording"],"summary":"Query for recording retention data","description":"","operationId":"getRecordingsRetentionQuery","produces":["application/json"],"parameters":[{"name":"retentionThresholdDays","in":"query","description":"Fetch retention data for recordings retained for more days than the provided value.","required":true,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size. Maximum is 500.","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingRetentionCursorEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"The recording:recording:view permission is required.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view"]},"x-purecloud-method-name":"getRecordingsRetentionQuery"}},"/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}":{"get":{"tags":["Recording"],"summary":"Get annotation","description":"","operationId":"getConversationRecordingAnnotation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","recording.annotation.view.permission.check.failed":"Failed to verify view annotation permission","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","recording.annotation.not.found":"The recording annotation was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:view"]},"x-purecloud-method-name":"getConversationRecordingAnnotation"},"put":{"tags":["Recording"],"summary":"Update annotation","description":"","operationId":"putConversationRecordingAnnotation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"annotation","required":true,"schema":{"$ref":"#/definitions/Annotation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.annotation.description.too.long":"Annotation description too long.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.invalid.json":"Request contains invalid JSON.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Failed to verify recording view permission.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.annotation.update.permission.check.failed":"Failed to verify recording update permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.recordingsegment.view.permission.check.failed":"Failed to verify recording segment view permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:edit","recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"putConversationRecordingAnnotation"},"delete":{"tags":["Recording"],"summary":"Delete annotation","description":"","operationId":"deleteConversationRecordingAnnotation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","recording.annotation.cant.delete.for.another.user":"Can't delete a recording annotation for another user.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.annotation.delete.permission.check.failed":"Failed to verify recording delete permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:delete"]},"x-purecloud-method-name":"deleteConversationRecordingAnnotation"}},"/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations":{"get":{"tags":["Recording"],"summary":"Get annotations for recording","description":"","operationId":"getConversationRecordingAnnotations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Annotation"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:view"]},"x-purecloud-method-name":"getConversationRecordingAnnotations"},"post":{"tags":["Recording"],"summary":"Create annotation","description":"","operationId":"postConversationRecordingAnnotations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"annotation","required":true,"schema":{"$ref":"#/definitions/Annotation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.annotation.description.too.long":"Annotation description too long.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.invalid.json":"Request contains invalid JSON.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:add"]},"x-purecloud-method-name":"postConversationRecordingAnnotations"}},"/api/v2/recording/jobs/{jobId}/failedrecordings":{"get":{"tags":["Recording"],"summary":"Get IDs of recordings that the bulk job failed for","description":"","operationId":"getRecordingJobFailedrecordings","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size. Maximum is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"includeTotal","in":"query","description":"If false, cursor will be used to locate the page instead of pageNumber.","required":false,"type":"boolean"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FailedRecordingEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:view"]},"x-purecloud-method-name":"getRecordingJobFailedrecordings"}},"/api/v2/recording/jobs/{jobId}":{"get":{"tags":["Recording"],"summary":"Get the status of the job associated with the job id.","description":"","operationId":"getRecordingJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:view"]},"x-purecloud-method-name":"getRecordingJob"},"put":{"tags":["Recording"],"summary":"Execute the recording bulk job.","description":"A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recording's retention.","operationId":"putRecordingJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ExecuteRecordingJobsQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:edit","recording:recording:editRetention","recording:screenRecording:editRetention"]},"x-purecloud-method-name":"putRecordingJob"},"delete":{"tags":["Recording"],"summary":"Delete the recording bulk job","description":"","operationId":"deleteRecordingJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:delete"]},"x-purecloud-method-name":"deleteRecordingJob"}},"/api/v2/recording/jobs":{"get":{"tags":["Recording"],"summary":"Get the status of all jobs within the user's organization","description":"","operationId":"getRecordingJobs","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"userId","enum":["userId","dateCreated"]},{"name":"state","in":"query","description":"Filter by state","required":false,"type":"string","enum":["FULFILLED","PENDING","READY","PROCESSING","CANCELLED","FAILED"]},{"name":"showOnlyMyJobs","in":"query","description":"Show only my jobs","required":false,"type":"boolean"},{"name":"jobType","in":"query","description":"Job Type (Can be left empty for both)","required":false,"type":"string","enum":["ARCHIVE","DELETE","EXPORT"]},{"name":"includeTotal","in":"query","description":"If false, cursor will be used to locate the page instead of pageNumber.","required":false,"type":"boolean"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingJobEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:view"]},"x-purecloud-method-name":"getRecordingJobs"},"post":{"tags":["Recording"],"summary":"Create a recording bulk job.","description":"Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data when redaction is enabled for their organization. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected.","operationId":"postRecordingJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/RecordingJobsQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/RecordingJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled for actionAge and screen recording parameters"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:add"]},"x-purecloud-method-name":"postRecordingJobs"}},"/api/v2/recording/settings":{"get":{"tags":["Recording"],"summary":"Get the Recording Settings for the Organization","description":"","operationId":"getRecordingSettings","produces":["application/json"],"parameters":[{"name":"createDefault","in":"query","description":"If no settings are found, a new one is created with default values","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error getting recording settings","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:screenRecording:view","recording:settings:editScreenRecordings"]},"x-purecloud-method-name":"getRecordingSettings"},"put":{"tags":["Recording"],"summary":"Update the Recording Settings for the Organization","description":"","operationId":"putRecordingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Recording settings","required":true,"schema":{"$ref":"#/definitions/RecordingSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.org.settings.request.invalid":"invalid recording setting","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:settings:editScreenRecordings"]},"x-purecloud-method-name":"putRecordingSettings"}},"/api/v2/recording/uploads/reports/{reportId}":{"get":{"tags":["Recording"],"summary":"Get the status of a recording upload status report","description":"","operationId":"getRecordingUploadsReport","produces":["application/json"],"parameters":[{"name":"reportId","in":"path","description":"reportId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingUploadReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:uploadReport:view"]},"x-purecloud-method-name":"getRecordingUploadsReport"}},"/api/v2/recording/uploads/reports":{"post":{"tags":["Recording"],"summary":"Creates a recording upload status report","description":"","operationId":"postRecordingUploadsReports","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Report parameters","required":true,"schema":{"$ref":"#/definitions/RecordingUploadReportRequest"}}],"responses":{"202":{"description":"Accepted - preparing report.","schema":{"$ref":"#/definitions/RecordingUploadReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:uploadReport:add"]},"x-purecloud-method-name":"postRecordingUploadsReports"}},"/api/v2/recordings/screensessions/metadata":{"post":{"tags":["Recording"],"summary":"Provide meta-data a screen recording.","description":"","operationId":"postRecordingsScreensessionsMetadata","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ScreenRecordingMetaDataRequest","required":true,"schema":{"$ref":"#/definitions/ScreenRecordingMetaDataRequest"}}],"responses":{"204":{"description":"Meta-data supplied to screen recording."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postRecordingsScreensessionsMetadata"}},"/api/v2/recordings/screensessions":{"get":{"tags":["Recording"],"summary":"Retrieves a paged listing of screen recording sessions","description":"Coming soon: This API is deprecated and will be replaced by /api/v2/recordings/screensessions/details","operationId":"getRecordingsScreensessions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScreenRecordingSessionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:screenRecording:view"]},"x-purecloud-method-name":"getRecordingsScreensessions"}},"/api/v2/recordings/screensessions/details":{"get":{"tags":["Recording"],"summary":"Retrieves an object containing the total number of concurrent active screen recordings","description":"","operationId":"getRecordingsScreensessionsDetails","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScreenRecordingActiveSessions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:screenRecording:view"]},"x-purecloud-method-name":"getRecordingsScreensessionsDetails"}},"/api/v2/recordings/screensessions/{recordingSessionId}":{"patch":{"tags":["Recording"],"summary":"Update a screen recording session","description":"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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postRecordingsScreensessionsAcknowledge"}},"/api/v2/quality/forms/surveys/{formId}":{"get":{"tags":["Quality"],"summary":"Get a survey form","description":"","operationId":"getQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"survey.not.found":"Survey formId not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurvey"},"put":{"tags":["Quality"],"summary":"Update a survey form.","description":"","operationId":"putQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/SurveyForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"composer.answer.option.value.too.large":"Answer option value is too large","composer.question.too.many.answer.options":"Question has too many answer options'","bad.request":"The request could not be understood by the server due to malformed syntax.","composer.question.group.name.too.long":"Question group name is too long","composer.form.name.too.long":"Survey form name is too long","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","composer.help.text.too.long":"Help text is too long","composer.answer.option.text.too.long":"Answer option text is too long","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","survey.form.invalid":"Survey form is not valid","composer.form.too.many.questions":"Survey form has too many questions","composer.explanation.prompt.text.too.long":"Explanation prompt text is too long","composer.question.text.too.long":"Question text is too long","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"survey.name.conflict":"Survey form named has a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:edit"]},"x-purecloud-method-name":"putQualityFormsSurvey"},"delete":{"tags":["Quality"],"summary":"Delete a survey form.","description":"","operationId":"deleteQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"survey.cannot.be.deleted":"Cannot delete survey because it has already been published."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:delete"]},"x-purecloud-method-name":"deleteQualityFormsSurvey"},"patch":{"tags":["Quality"],"summary":"Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form.","description":"","operationId":"patchQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/SurveyForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:disable"]},"x-purecloud-method-name":"patchQualityFormsSurvey"}},"/api/v2/quality/forms/surveys/{formId}/versions":{"get":{"tags":["Quality"],"summary":"Gets all the revisions for a specific survey.","description":"","operationId":"getQualityFormsSurveyVersions","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveyVersions"}},"/api/v2/quality/forms/surveys/bulk":{"get":{"tags":["Quality"],"summary":"Retrieve a list of survey forms by their ids","description":"","operationId":"getQualityFormsSurveysBulk","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"A comma-delimited list of valid survey form ids","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveysBulk"}},"/api/v2/quality/forms/surveys/bulk/contexts":{"get":{"tags":["Quality"],"summary":"Retrieve a list of the latest form versions by context ids","description":"","operationId":"getQualityFormsSurveysBulkContexts","produces":["application/json"],"parameters":[{"name":"contextId","in":"query","description":"A comma-delimited list of valid survey form context ids. The maximum number of ids allowed in this list is 100.","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"published","in":"query","description":"If true, the latest published version will be included. If false, only the unpublished version will be included.","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/SurveyForm"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveysBulkContexts"}},"/api/v2/quality/forms/surveys":{"get":{"tags":["Quality"],"summary":"Get the list of survey forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding survey form.","description":"","operationId":"getQualityFormsSurveys","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"expand","in":"query","description":"If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions","required":false,"type":"string","enum":["publishHistory"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Order to sort results, either asc or desc","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveys"},"post":{"tags":["Quality"],"summary":"Create a survey form.","description":"","operationId":"postQualityFormsSurveys","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/SurveyForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"composer.answer.option.value.too.large":"Answer option value is too large","composer.question.too.many.answer.options":"Question has too many answer options'","bad.request":"The request could not be understood by the server due to malformed syntax.","composer.question.group.name.too.long":"Question group name is too long","composer.form.name.too.long":"Survey form name is too long","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","composer.help.text.too.long":"Help text is too long","composer.answer.option.text.too.long":"Answer option text is too long","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","survey.form.invalid":"Survey form is not valid","composer.form.too.many.questions":"Survey form has too many questions","composer.explanation.prompt.text.too.long":"Explanation prompt text is too long","composer.question.text.too.long":"Question text is too long","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"survey.name.conflict":"Survey form named has a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:add"]},"x-purecloud-method-name":"postQualityFormsSurveys"}},"/api/v2/quality/surveys/{surveyId}":{"get":{"tags":["Quality"],"summary":"Get a survey for a conversation","description":"","operationId":"getQualitySurvey","produces":["application/json"],"parameters":[{"name":"surveyId","in":"path","description":"surveyId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Survey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.survey.view.permission.check.failed":"Failed to check required view permission.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:survey:view"]},"x-purecloud-method-name":"getQualitySurvey"}},"/api/v2/quality/surveys/scoring":{"post":{"tags":["Quality"],"summary":"Score survey","description":"","operationId":"postQualitySurveysScoring","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"surveyAndScoringSet","required":true,"schema":{"$ref":"#/definitions/SurveyFormAndScoringSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyScoringSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-purecloud-method-name":"postQualitySurveysScoring"}},"/api/v2/quality/forms/{formId}":{"get":{"tags":["Quality"],"summary":"Get an evaluation form","description":"","operationId":"getQualityForm","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.form.invalid":"The specified formId is not valid","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","evaluation.not.found":"Evaluation form not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityForm"},"put":{"tags":["Quality"],"summary":"Update an evaluation form.","description":"","operationId":"putQualityForm","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.form.invalid":"Evaluation form is not valid","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","composer.form.name.too.long":"Evaluation form name is too long","invalid.property":"Value [%s] is not a valid property for object [%s]","composer.form.too.many.questions":"Evaluation form has too many questions","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.name.conflict":"Evaluation form named has a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:edit"]},"x-purecloud-method-name":"putQualityForm"},"delete":{"tags":["Quality"],"summary":"Delete an evaluation form.","description":"","operationId":"deleteQualityForm","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.cannot.be.deleted":"Cannot delete evaluation because it has already been published."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:delete"]},"x-purecloud-method-name":"deleteQualityForm"}},"/api/v2/quality/forms/{formId}/versions":{"get":{"tags":["Quality"],"summary":"Gets all the revisions for a specific evaluation.","description":"","operationId":"getQualityFormVersions","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormVersions"}},"/api/v2/quality/forms":{"get":{"tags":["Quality"],"summary":"Get the list of evaluation forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding evaluation form.","description":"","operationId":"getQualityForms","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"expand","in":"query","description":"If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions","required":false,"type":"string","enum":["publishHistory"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Order to sort results, either asc or desc","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityForms"},"post":{"tags":["Quality"],"summary":"Create an evaluation form.","description":"","operationId":"postQualityForms","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.form.invalid":"Evaluation form is not valid","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","composer.form.name.too.long":"Evaluation form name is too long","invalid.property":"Value [%s] is not a valid property for object [%s]","composer.form.too.many.questions":"Evaluation form has too many questions","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.name.conflict":"Evaluation form named has a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityForms"}},"/api/v2/quality/publishedforms/{formId}":{"get":{"tags":["Quality"],"summary":"Get the published evaluation forms.","description":"","operationId":"getQualityPublishedform","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","evaluation.not.found":"Requested formId not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedform"}},"/api/v2/quality/publishedforms":{"get":{"tags":["Quality"],"summary":"Get the published evaluation forms.","description":"","operationId":"getQualityPublishedforms","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"onlyLatestPerContext","in":"query","description":"onlyLatestPerContext","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedforms"},"post":{"tags":["Quality"],"summary":"Publish an evaluation form.","description":"","operationId":"postQualityPublishedforms","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Publish request containing id of form to publish","required":true,"schema":{"$ref":"#/definitions/PublishForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.already.published":"Evaluation has already been published."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityPublishedforms"}},"/api/v2/alerting/alerts/{alertId}":{"get":{"tags":["Alerting"],"summary":"Get an alert","description":"","operationId":"getAlertingAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonAlert"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:view"]},"x-purecloud-method-name":"getAlertingAlert"},"put":{"tags":["Alerting"],"summary":"Update an alert read status","description":"","operationId":"putAlertingAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AlertingUnreadStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnreadStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:edit"]},"x-purecloud-method-name":"putAlertingAlert"},"delete":{"tags":["Alerting"],"summary":"Delete an alert","description":"","operationId":"deleteAlertingAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"}],"responses":{"204":{"description":"Alert deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:delete"]},"x-purecloud-method-name":"deleteAlertingAlert"},"patch":{"tags":["Alerting"],"summary":"Allows an entity to mute/snooze an alert or update the unread status of the alert.","description":"Snoozing an alert temporarily stop it from resending notifications to individualsas well as other services within Genesys Cloud for a given period. Muting an alert will only block the notifications to individuals.","operationId":"patchAlertingAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AlertRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonAlert"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:edit"]},"x-purecloud-method-name":"patchAlertingAlert"}},"/api/v2/alerting/alerts/bulk":{"patch":{"tags":["Alerting"],"summary":"Bulk alert updates","description":"","operationId":"patchAlertingAlertsBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CommonAlertBulkUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:edit"]},"x-purecloud-method-name":"patchAlertingAlertsBulk"}},"/api/v2/alerting/alerts/query":{"post":{"tags":["Alerting"],"summary":"Gets a paged list of alerts. The max page size is 50","description":"","operationId":"postAlertingAlertsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/GetAlertQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlertListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:view"]},"x-purecloud-method-name":"postAlertingAlertsQuery"}},"/api/v2/alerting/rules/{ruleId}":{"get":{"tags":["Alerting"],"summary":"Get a rule.","description":"","operationId":"getAlertingRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:view"]},"x-purecloud-method-name":"getAlertingRule"},"put":{"tags":["Alerting"],"summary":"Update a rule","description":"","operationId":"putAlertingRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule Id","required":true,"type":"string"},{"in":"body","name":"body","description":"rule to be updated","required":true,"schema":{"$ref":"#/definitions/ModifiableRuleProperties"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:edit"]},"x-purecloud-method-name":"putAlertingRule"},"delete":{"tags":["Alerting"],"summary":"Delete a rule.","description":"","operationId":"deleteAlertingRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule Id","required":true,"type":"string"}],"responses":{"204":{"description":"Rule deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:delete"]},"x-purecloud-method-name":"deleteAlertingRule"}},"/api/v2/alerting/rules/bulk":{"patch":{"tags":["Alerting"],"summary":"Bulk update of notification lists","description":"","operationId":"patchAlertingRulesBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CommonRuleBulkUpdateNotificationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:edit"]},"x-purecloud-method-name":"patchAlertingRulesBulk"}},"/api/v2/alerting/rules/bulk/remove":{"post":{"tags":["Alerting"],"summary":"Bulk remove rules","description":"","operationId":"postAlertingRulesBulkRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CommonRuleBulkDeleteRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:delete"]},"x-purecloud-method-name":"postAlertingRulesBulkRemove"}},"/api/v2/alerting/rules/query":{"post":{"tags":["Alerting"],"summary":"Get a paged list of rules. The max size of the page is 50 items.","description":"","operationId":"postAlertingRulesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/GetRulesQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonRuleContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:view"]},"x-purecloud-method-name":"postAlertingRulesQuery"}},"/api/v2/alerting/rules":{"post":{"tags":["Alerting"],"summary":"Create a Rule.","description":"","operationId":"postAlertingRules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"rule to be created","required":true,"schema":{"$ref":"#/definitions/CommonRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonRule"}},"201":{"description":"Rule created.","schema":{"$ref":"#/definitions/CommonRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:add"]},"x-purecloud-method-name":"postAlertingRules"}},"/api/v2/responsemanagement/libraries/bulk":{"post":{"tags":["Response Management"],"summary":"Get response libraries.","description":"","operationId":"postResponsemanagementLibrariesBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"LibraryIDs (max allowed 50)","required":true,"schema":{"$ref":"#/definitions/LibraryBatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LibraryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.exceeds.maximum.library.batch.size":"Exceeds maximum batch size limit.","rms.missing.field":"Missing Field.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:library:view"]},"x-purecloud-method-name":"postResponsemanagementLibrariesBulk"}},"/api/v2/responsemanagement/libraries":{"get":{"tags":["Response Management"],"summary":"Gets a list of existing response libraries.","description":"","operationId":"getResponsemanagementLibraries","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"messagingTemplateFilter","in":"query","description":"Returns a list of libraries that contain responses with at least one messaging template defined for a specific message channel","required":false,"type":"string","enum":["whatsapp"]},{"name":"libraryPrefix","in":"query","description":"Returns a list of libraries that contain the prefix provided","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LibraryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:library:view"]},"x-purecloud-method-name":"getResponsemanagementLibraries"},"post":{"tags":["Response Management"],"summary":"Create a response library.","description":"","operationId":"postResponsemanagementLibraries","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Library","required":true,"schema":{"$ref":"#/definitions/Library"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:library:add"]},"x-purecloud-method-name":"postResponsemanagementLibraries"}},"/api/v2/responsemanagement/libraries/{libraryId}":{"get":{"tags":["Response Management"],"summary":"Get details about an existing response library.","description":"","operationId":"getResponsemanagementLibrary","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.library.not.found":"The response library could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:library:view"]},"x-purecloud-method-name":"getResponsemanagementLibrary"},"put":{"tags":["Response Management"],"summary":"Update an existing response library.","description":"Fields that can be updated: name. The most recent version is required for updates.","operationId":"putResponsemanagementLibrary","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Library","required":true,"schema":{"$ref":"#/definitions/Library"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided"},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:library:edit"]},"x-purecloud-method-name":"putResponsemanagementLibrary"},"delete":{"tags":["Response Management"],"summary":"Delete an existing response library.","description":"This will remove any responses associated with the library.","operationId":"deleteResponsemanagementLibrary","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:library:delete"]},"x-purecloud-method-name":"deleteResponsemanagementLibrary"}},"/api/v2/responsemanagement/responses/query":{"post":{"tags":["Response Management"],"summary":"Query responses","description":"","operationId":"postResponsemanagementResponsesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Response","required":true,"schema":{"$ref":"#/definitions/ResponseQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseQueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","rms.field.unexpected.value":"One or more fields in the payload contained unexpected values."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.internal.server.error":"The request failed due to an internal server error.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:response:view"]},"x-purecloud-method-name":"postResponsemanagementResponsesQuery"}},"/api/v2/responsemanagement/responses/{responseId}":{"get":{"tags":["Response Management"],"summary":"Get details about an existing response.","description":"","operationId":"getResponsemanagementResponse","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","rms.response.not.found":"The response could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:response:view"]},"x-purecloud-method-name":"getResponsemanagementResponse"},"put":{"tags":["Response Management"],"summary":"Update an existing response.","description":"Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.","operationId":"putResponsemanagementResponse","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Response","required":true,"schema":{"$ref":"#/definitions/Response"}},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided"},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:response:edit"]},"x-purecloud-method-name":"putResponsemanagementResponse"},"delete":{"tags":["Response Management"],"summary":"Delete an existing response.","description":"This will remove the response from any libraries associated with it.","operationId":"deleteResponsemanagementResponse","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:response:delete"]},"x-purecloud-method-name":"deleteResponsemanagementResponse"}},"/api/v2/responsemanagement/responses":{"get":{"tags":["Response Management"],"summary":"Gets a list of existing responses.","description":"","operationId":"getResponsemanagementResponses","produces":["application/json"],"parameters":[{"name":"libraryId","in":"query","description":"Library ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:response:view"]},"x-purecloud-method-name":"getResponsemanagementResponses"},"post":{"tags":["Response Management"],"summary":"Create a response.","description":"","operationId":"postResponsemanagementResponses","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Response","required":true,"schema":{"$ref":"#/definitions/Response"}},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.not.a.user":"Unable to find user","rms.exceeds.asset.maximum.file.size":"Response asset file size exceeds limit.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","rms.exceeds.maximum.mms.response.assets":"Too many response assets","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"412":{"description":"Precondition Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.precondition":"Response precondition not met."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:response:add"]},"x-purecloud-method-name":"postResponsemanagementResponses"}},"/api/v2/responsemanagement/responseassets/{responseAssetId}":{"get":{"tags":["Response Management"],"summary":"Get response asset information","description":"","operationId":"getResponsemanagementResponseasset","produces":["application/json"],"parameters":[{"name":"responseAssetId","in":"path","description":"Asset Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responseAssets:asset:view"]},"x-purecloud-method-name":"getResponsemanagementResponseasset"},"put":{"tags":["Response Management"],"summary":"Update response asset","description":"","operationId":"putResponsemanagementResponseasset","produces":["application/json"],"parameters":[{"name":"responseAssetId","in":"path","description":"Asset Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request","required":true,"schema":{"$ref":"#/definitions/ResponseAssetRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["responseAssets:asset:edit"]},"x-purecloud-method-name":"putResponsemanagementResponseasset"},"delete":{"tags":["Response Management"],"summary":"Delete response asset","description":"","operationId":"deleteResponsemanagementResponseasset","produces":["application/json"],"parameters":[{"name":"responseAssetId","in":"path","description":"Asset Id","required":true,"type":"string"}],"responses":{"204":{"description":"Response asset is deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responseAssets:asset:delete"]},"x-purecloud-method-name":"deleteResponsemanagementResponseasset"}},"/api/v2/responsemanagement/responseassets/status/{statusId}":{"get":{"tags":["Response Management"],"summary":"Get response asset upload status","description":"","operationId":"getResponsemanagementResponseassetsStatusStatusId","produces":["application/json"],"parameters":[{"name":"statusId","in":"path","description":"Status Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseAssetStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responseAssets:asset:view"]},"x-purecloud-method-name":"getResponsemanagementResponseassetsStatusStatusId"}},"/api/v2/responsemanagement/responseassets/uploads":{"post":{"tags":["Response Management"],"summary":"Creates pre-signed url for uploading response asset","description":"","operationId":"postResponsemanagementResponseassetsUploads","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"request","required":true,"schema":{"$ref":"#/definitions/CreateResponseAssetRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateResponseAssetResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.content.md5":"Invalid Content","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responseAssets:asset:add"]},"x-purecloud-method-name":"postResponsemanagementResponseassetsUploads"}},"/api/v2/responsemanagement/responseassets/search":{"post":{"tags":["Response Management"],"summary":"Search response assets","description":"","operationId":"postResponsemanagementResponseassetsSearch","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["user","division"]},"collectionFormat":"multi"},{"in":"body","name":"body","description":"request","required":true,"schema":{"$ref":"#/definitions/ResponseAssetSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseAssetSearchResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["responseAssets:asset:view"]},"x-purecloud-method-name":"postResponsemanagementResponseassetsSearch"}},"/api/v2/routing/availablemediatypes":{"get":{"tags":["Routing"],"summary":"Get available media types","description":"","operationId":"getRoutingAvailablemediatypes","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableMediaTypeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingAvailablemediatypes"}},"/api/v2/routing/languages/{languageId}":{"get":{"tags":["Routing"],"summary":"Get a routing language","description":"","operationId":"getRoutingLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingLanguage"},"delete":{"tags":["Routing"],"summary":"Delete a routing language","description":"","operationId":"deleteRoutingLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"deleteRoutingLanguage"}},"/api/v2/routing/languages":{"get":{"tags":["Routing"],"summary":"Get the list of supported languages.","description":"","operationId":"getRoutingLanguages","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingLanguages"},"post":{"tags":["Routing"],"summary":"Create Language","description":"","operationId":"postRoutingLanguages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Language","required":true,"schema":{"$ref":"#/definitions/Language"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The request could not be completed by the server due to a conflict."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"postRoutingLanguages"}},"/api/v2/routing/queues/divisionviews":{"get":{"tags":["Routing"],"summary":"Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).","description":"","operationId":"getRoutingQueuesDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size [max value is 100]","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number [max value is 5]","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name","enum":["name","id","divisionId"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"Queue ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"Internal server error getting paged listing of queue objects."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:search"]},"x-purecloud-method-name":"getRoutingQueuesDivisionviews"}},"/api/v2/routing/queues/divisionviews/all":{"get":{"tags":["Routing"],"summary":"Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.","description":"","operationId":"getRoutingQueuesDivisionviewsAll","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size [max value is 500]","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc","enum":["asc","desc"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:search"]},"x-purecloud-method-name":"getRoutingQueuesDivisionviewsAll"}},"/api/v2/routing/queues/{queueId}":{"get":{"tags":["Routing"],"summary":"Get details about this queue.","description":"","operationId":"getRoutingQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueue"},"put":{"tags":["Routing"],"summary":"Update a queue","description":"","operationId":"putRoutingQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue","required":true,"schema":{"$ref":"#/definitions/QueueRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Invalid media type specified.","bad.request":"Invalid request data.","duplicate.name":"A queue with this name already exists.","queue.deleted":"Queue has been deleted.","constraint.validation":"%s","invalid.library.ids":"One or more specified canned response libraries are not found, and cannot be set","invalid.name":"Invalid queue name specified.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","queue.ring.has.members":"One or more bullseye rings cannot be removed, due to having assigned members.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","skill.does.not.exist":"Specified skill does not exist.","invalid.answering.machine.flow":"Specified answering machine outbound flow is not active.","invalid.whats.app.recipient.id":"The specified outbound WhatsApp recipient is not active, and cannot be set.","source.queue.not.found":"Source queue not found.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.rule":"Invalid routing rule specified.","invalid.outbound.messaging.address.state":"Specified outbound messaging address is not active.","invalid.type":"Invalid object type specified.","resource.not.found":"A referenced resource, such as a division, was not found.","invalid.open.messaging.recipient.id":"The specified outbound OpenMessaging recipient is not active, and cannot be set.","invalid.live.voice.flow":"Specified live voice in-queue flow is not active.","invalid.media.subtype":"Invalid media subtype specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.phone.number":"Invalid phone number specified.","invalid.id":"A required ID was missing or invalid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit"]},"x-purecloud-method-name":"putRoutingQueue"},"delete":{"tags":["Routing"],"summary":"Delete a queue","description":"","operationId":"deleteRoutingQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"forceDelete","in":"query","description":"forceDelete","required":false,"type":"boolean"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.id":"A non-UUID value was specified for an ID field.","active.queue":"Queue contains active conversations."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:delete"]},"x-purecloud-method-name":"deleteRoutingQueue"}},"/api/v2/routing/queues/{queueId}/wrapupcodes":{"get":{"tags":["Routing"],"summary":"Get the wrap-up codes for a queue","description":"","operationId":"getRoutingQueueWrapupcodes","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCodeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueWrapupcodes"},"post":{"tags":["Routing"],"summary":"Add up to 100 wrap-up codes to a queue","description":"","operationId":"postRoutingQueueWrapupcodes","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of wrapup codes","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WrapUpCodeReference"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure you submit a valid number of wrapup codes.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The specified queue was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:edit"]},"x-purecloud-method-name":"postRoutingQueueWrapupcodes"}},"/api/v2/routing/queues/{queueId}/wrapupcodes/{codeId}":{"delete":{"tags":["Routing"],"summary":"Delete a wrap-up code from a queue","description":"","operationId":"deleteRoutingQueueWrapupcode","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"codeId","in":"path","description":"Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.id":"A non-UUID value was specified for an ID field."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:edit"]},"x-purecloud-method-name":"deleteRoutingQueueWrapupcode"}},"/api/v2/routing/queues/me":{"get":{"tags":["Routing"],"summary":"Get a paged listing of queues the user is a member of.","description":"","operationId":"getRoutingQueuesMe","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"joined","in":"query","description":"Filter by joined status.","required":false,"type":"boolean","enum":["true","false"]},{"name":"sortOrder","in":"query","description":"Note: results are sorted by name.","required":false,"type":"string","default":"asc","enum":["asc","desc"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingQueuesMe"}},"/api/v2/routing/queues":{"get":{"tags":["Routing"],"summary":"Get list of queues.","description":"","operationId":"getRoutingQueues","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Note: results are sorted by name.","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"name","in":"query","description":"Include only queues with the given name (leading and trailing asterisks allowed)","required":false,"type":"string"},{"name":"id","in":"query","description":"Include only queues with the specified ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Include only queues in the specified division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"peerId","in":"query","description":"Include only queues with the specified peer ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"cannedResponseLibraryId","in":"query","description":"Include only queues explicitly associated with the specified canned response library ID","required":false,"type":"string"},{"name":"hasPeer","in":"query","description":"Include only queues with a peer ID","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"Internal server error getting queue listing."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueues"},"post":{"tags":["Routing"],"summary":"Create a queue","description":"","operationId":"postRoutingQueues","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Queue","required":true,"schema":{"$ref":"#/definitions/CreateQueueRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Invalid media type specified.","invalid.phone.numbers":"Invalid phone numbers specified.","bad.request":"Invalid request data.","duplicate.name":"A queue with this name already exists.","queue.deleted":"Queue has been deleted.","constraint.validation":"%s","invalid.library.ids":"One or more specified canned response libraries are not found, and cannot be set","invalid.name":"Invalid queue name specified.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","skill.does.not.exist":"Specified skill does not exist.","queue.limit.exceeded":"Adding the requested queue would exceed the queue limit.","invalid.answering.machine.flow":"Specified answering machine outbound flow is not active.","invalid.whats.app.recipient.id":"The specified outbound WhatsApp recipient is not active, and cannot be set.","source.queue.not.found":"Source queue not found.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.rule":"Invalid routing rule specified.","invalid.outbound.messaging.address.state":"Specified outbound messaging address is not active.","invalid.type":"Invalid object type specified.","resource.not.found":"A resource (e.g., a skill) referenced in the queue configuration was not found.","invalid.open.messaging.recipient.id":"The specified outbound OpenMessaging recipient is not active, and cannot be set.","invalid.live.voice.flow":"Specified live voice in-queue flow is not active.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.phone.number":"Invalid phone number specified.","invalid.id":"A required ID was missing or invalid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"A required resource (e.g., the source queue) was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:add"]},"x-purecloud-method-name":"postRoutingQueues"}},"/api/v2/routing/settings/transcription":{"get":{"tags":["Routing"],"summary":"Get Transcription Settings","description":"","operationId":"getRoutingSettingsTranscription","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"Requested feature is forbidden","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:transcriptionSettings:view"]},"x-purecloud-method-name":"getRoutingSettingsTranscription"},"put":{"tags":["Routing"],"summary":"Update Transcription Settings","description":"","operationId":"putRoutingSettingsTranscription","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization Settings","required":true,"schema":{"$ref":"#/definitions/TranscriptionSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"202":{"description":"Request to update transcription settings has been accepted","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:transcriptionSettings:edit"]},"x-purecloud-method-name":"putRoutingSettingsTranscription"},"patch":{"tags":["Routing"],"summary":"Patch Transcription Settings","description":"","operationId":"patchRoutingSettingsTranscription","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization Settings","required":true,"schema":{"$ref":"#/definitions/TranscriptionSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"202":{"description":"Request to update transcription settings has been accepted","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:transcriptionSettings:edit"]},"x-purecloud-method-name":"patchRoutingSettingsTranscription"}},"/api/v2/routing/settings/contactcenter":{"get":{"tags":["Routing"],"summary":"Get Contact Center Settings","description":"","operationId":"getRoutingSettingsContactcenter","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactCenterSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSettingsContactcenter"},"patch":{"tags":["Routing"],"summary":"Update Contact Center Settings","description":"","operationId":"patchRoutingSettingsContactcenter","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contact Center Settings","required":true,"schema":{"$ref":"#/definitions/ContactCenterSettings"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:settings:edit"]},"x-purecloud-method-name":"patchRoutingSettingsContactcenter"}},"/api/v2/routing/settings":{"get":{"tags":["Routing"],"summary":"Get an organization's routing settings","description":"","operationId":"getRoutingSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSettings"},"put":{"tags":["Routing"],"summary":"Update an organization's routing settings","description":"","operationId":"putRoutingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization Settings","required":true,"schema":{"$ref":"#/definitions/RoutingSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:settings:edit"]},"x-purecloud-method-name":"putRoutingSettings"},"delete":{"tags":["Routing"],"summary":"Delete an organization's routing settings","description":"","operationId":"deleteRoutingSettings","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:settings:edit"]},"x-purecloud-method-name":"deleteRoutingSettings"}},"/api/v2/routing/skills/{skillId}":{"get":{"tags":["Routing"],"summary":"Get Routing Skill","description":"","operationId":"getRoutingSkill","produces":["application/json"],"parameters":[{"name":"skillId","in":"path","description":"Skill ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSkill"},"delete":{"tags":["Routing"],"summary":"Delete Routing Skill","description":"","operationId":"deleteRoutingSkill","produces":["application/json"],"parameters":[{"name":"skillId","in":"path","description":"Skill ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"deleteRoutingSkill"}},"/api/v2/routing/skills":{"get":{"tags":["Routing"],"summary":"Get the list of routing skills.","description":"","operationId":"getRoutingSkills","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Filter for results that start with this value","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSkills"},"post":{"tags":["Routing"],"summary":"Create Skill","description":"","operationId":"postRoutingSkills","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Skill","required":true,"schema":{"$ref":"#/definitions/RoutingSkill"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The request could not be completed by the server due to a conflict."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"postRoutingSkills"}},"/api/v2/routing/utilization/labels/{labelId}":{"get":{"tags":["Routing"],"summary":"Get details about this utilization label","description":"","operationId":"getRoutingUtilizationLabel","produces":["application/json"],"parameters":[{"name":"labelId","in":"path","description":"Utilization Label ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationLabel"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilizationLabel"},"put":{"tags":["Routing"],"summary":"Update a utilization label","description":"","operationId":"putRoutingUtilizationLabel","produces":["application/json"],"parameters":[{"name":"labelId","in":"path","description":"Utilization Label ID","required":true,"type":"string"},{"in":"body","name":"body","description":"UtilizationLabel","required":true,"schema":{"$ref":"#/definitions/UpdateUtilizationLabelRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationLabel"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"putRoutingUtilizationLabel"},"delete":{"tags":["Routing"],"summary":"Delete a utilization label","description":"","operationId":"deleteRoutingUtilizationLabel","produces":["application/json"],"parameters":[{"name":"labelId","in":"path","description":"Utilization Label ID","required":true,"type":"string"},{"name":"forceDelete","in":"query","description":"Remove all label usages (if found) without warning","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.utilization.label":"Utilization label cannot be deleted due to its usage in max utilization.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"deleteRoutingUtilizationLabel"}},"/api/v2/routing/utilization/labels/{labelId}/agents":{"get":{"tags":["Routing"],"summary":"Get list of agent ids associated with a utilization label","description":"","operationId":"getRoutingUtilizationLabelAgents","produces":["application/json"],"parameters":[{"name":"labelId","in":"path","description":"Utilization Label ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilizationLabelAgents"}},"/api/v2/routing/utilization/labels":{"get":{"tags":["Routing"],"summary":"Get list of utilization labels","description":"","operationId":"getRoutingUtilizationLabels","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order by name","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationLabelEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilizationLabels"},"post":{"tags":["Routing"],"summary":"Create a utilization label","description":"","operationId":"postRoutingUtilizationLabels","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"UtilizationLabel","required":true,"schema":{"$ref":"#/definitions/CreateUtilizationLabelRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationLabel"}},"201":{"description":"Utilization label created.","schema":{"$ref":"#/definitions/UtilizationLabel"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.utilization.label":"Invalid utilization label request.","invalid.name":"Invalid utilization code name specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"A utilization label with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"postRoutingUtilizationLabels"}},"/api/v2/routing/utilization":{"get":{"tags":["Routing"],"summary":"Get the organization-wide max utilization settings.","description":"","operationId":"getRoutingUtilization","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage","routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilization"},"put":{"tags":["Routing"],"summary":"Update the organization-wide max utilization settings. Include only those media types requiring custom configuration.","description":"","operationId":"putRoutingUtilization","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"utilization","required":true,"schema":{"$ref":"#/definitions/UtilizationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"An unsupported media type was specified.","interrupt.same.media.type":"A media type cannot be set up to interrupt itself.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.utilization.tag":"Invalid utilization tag provided.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.media.capacity":"Value too large or too small for media type.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Conflict updating utilization. Another update took place at the same time. Please try again."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"putRoutingUtilization"},"delete":{"tags":["Routing"],"summary":"Delete the organization-wide max utilization settings and revert to the system default.","description":"","operationId":"deleteRoutingUtilization","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Conflict updating utilization. Another update took place at the same time. Please try again."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"deleteRoutingUtilization"}},"/api/v2/routing/assessments/{assessmentId}":{"get":{"tags":["Routing"],"summary":"Retrieve a single benefit assessment.","description":"","operationId":"getRoutingAssessment","produces":["application/json"],"parameters":[{"name":"assessmentId","in":"path","description":"Benefit Assessment ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BenefitAssessment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","assessment.not.found":"Benefit Assessment not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:assessment:view"]},"x-purecloud-method-name":"getRoutingAssessment"},"delete":{"tags":["Routing"],"summary":"Delete single benefit assessment.","description":"","operationId":"deleteRoutingAssessment","produces":["application/json"],"parameters":[{"name":"assessmentId","in":"path","description":"Benefit Assessment ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:assessment:delete"]},"x-purecloud-method-name":"deleteRoutingAssessment"}},"/api/v2/routing/assessments":{"get":{"tags":["Routing"],"summary":"Retrieve all benefit assessments.","description":"","operationId":"getRoutingAssessments","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"queueId","in":"query","description":"Queue ID(s) to filter assessments by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssessmentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view","routing:assessment:view"]},"x-purecloud-method-name":"getRoutingAssessments"},"post":{"tags":["Routing"],"summary":"Create a benefit assessment.","description":"","operationId":"postRoutingAssessments","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateBenefitAssessmentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BenefitAssessment"}},"201":{"description":"Benefit Assessment created.","schema":{"$ref":"#/definitions/BenefitAssessment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"Unable to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:assessment:add","routing:queue:view"]},"x-purecloud-method-name":"postRoutingAssessments"}},"/api/v2/routing/assessments/jobs/{jobId}":{"get":{"tags":["Routing"],"summary":"Retrieve a single benefit assessments job.","description":"","operationId":"getRoutingAssessmentsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"Benefit Assessment Job ID","required":true,"type":"string"}],"responses":{"200":{"description":"The benefit assessment job is finished.","schema":{"$ref":"#/definitions/BenefitAssessmentJob"}},"202":{"description":"The benefit assessment job is created.","schema":{"$ref":"#/definitions/BenefitAssessmentJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","assessments.job.not.found":"Benefit Assessments Job not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:assessment:view"]},"x-purecloud-method-name":"getRoutingAssessmentsJob"}},"/api/v2/routing/assessments/jobs":{"get":{"tags":["Routing"],"summary":"Retrieve all benefit assessment jobs.","description":"","operationId":"getRoutingAssessmentsJobs","produces":["application/json"],"parameters":[{"name":"divisionId","in":"query","description":"Division ID(s) to filter assessment jobs by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssessmentJobListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingAssessmentsJobs"},"post":{"tags":["Routing"],"summary":"Create a benefit assessment job.","description":"","operationId":"postRoutingAssessmentsJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateBenefitAssessmentJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BenefitAssessmentJob"}},"202":{"description":"Benefit Assessment Job created.","schema":{"$ref":"#/definitions/BenefitAssessmentJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:assessment:add"]},"x-purecloud-method-name":"postRoutingAssessmentsJobs"}},"/api/v2/routing/conversations/{conversationId}":{"patch":{"tags":["Routing"],"summary":"Update attributes of an in-queue conversation","description":"Returns an object indicating the updated values of all settable attributes. Supported attributes: skillIds, languageId, and priority.","operationId":"patchRoutingConversation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation Attributes","required":true,"schema":{"$ref":"#/definitions/RoutingConversationAttributesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingConversationAttributesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A null or invalid attribute ID was specified.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","resource.not.found":"A specified skill or language does not exist."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The specified conversation does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:conversation:edit"]},"x-purecloud-method-name":"patchRoutingConversation"}},"/api/v2/routing/email/domains/{domainId}":{"get":{"tags":["Routing"],"summary":"Get domain","description":"","operationId":"getRoutingEmailDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomain"},"delete":{"tags":["Routing"],"summary":"Delete a domain","description":"","operationId":"deleteRoutingEmailDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"deleteRoutingEmailDomain"},"patch":{"tags":["Routing"],"summary":"Update domain settings","description":"","operationId":"patchRoutingEmailDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Domain settings","required":true,"schema":{"$ref":"#/definitions/InboundDomainPatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","email.error.integration.host":"The specified integration has a bad host.","email.error.integration.connection":"Unable to connect with the specified integration.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.not.found":"The inbound domain does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"patchRoutingEmailDomain"}},"/api/v2/routing/email/domains/{domainId}/validate":{"patch":{"tags":["Routing"],"summary":"Validate domain settings","description":"","operationId":"patchRoutingEmailDomainValidate","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Domain settings","required":true,"schema":{"$ref":"#/definitions/InboundDomainPatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","email.error.integration.host":"The specified integration has a bad host.","email.error.integration.connection":"Unable to connect with the specified integration.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.not.found":"The inbound domain does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"patchRoutingEmailDomainValidate"}},"/api/v2/routing/email/domains/{domainId}/testconnection":{"post":{"tags":["Routing"],"summary":"Tests the custom SMTP server integration connection set on this domain","description":"The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server. If the body is specified, there will be an attempt to send an email message to the server.","operationId":"postRoutingEmailDomainTestconnection","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"},{"in":"body","name":"body","description":"TestMessage","required":false,"schema":{"$ref":"#/definitions/TestMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","email.error.integration.host":"The specified integration has a bad host.","email.error.integration.connection":"Unable to connect with the specified integration.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailDomainTestconnection"}},"/api/v2/routing/email/domains":{"get":{"tags":["Routing"],"summary":"Get domains","description":"","operationId":"getRoutingEmailDomains","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"excludeStatus","in":"query","description":"Exclude MX record data","required":false,"type":"boolean","default":false},{"name":"filter","in":"query","description":"Optional search filter","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"Get domains request timed out.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomains"},"post":{"tags":["Routing"],"summary":"Create a domain","description":"","operationId":"postRoutingEmailDomains","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Domain","required":true,"schema":{"$ref":"#/definitions/InboundDomain"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.invalid.domain.name":"The 'domain' field contains some illegal characters.","constraint.validation":"%s","email.error.integration.host":"The specified integration has a bad host.","email.error.integration.connection":"Unable to connect with the specified integration.","postino.domain.exists":"The inbound domain already exists.","postino.max.domains.exceeded":"The maximum number of domains for the org has been exceeded.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailDomains"}},"/api/v2/routing/email/setup":{"get":{"tags":["Routing"],"summary":"Get email setup","description":"","operationId":"getRoutingEmailSetup","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailSetup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailSetup"}},"/api/v2/routing/email/outbound/domains/{domainId}":{"get":{"tags":["Routing"],"summary":"Get domain","description":"","operationId":"getRoutingEmailOutboundDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailOutboundDomain"},"delete":{"tags":["Routing"],"summary":"Delete an outbound domain","description":"","operationId":"deleteRoutingEmailOutboundDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"deleteRoutingEmailOutboundDomain"}},"/api/v2/routing/email/outbound/domains/{domainId}/search":{"get":{"tags":["Routing"],"summary":"Search a domain across organizations","description":"","operationId":"getRoutingEmailOutboundDomainSearch","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailOutboundDomainSearch"}},"/api/v2/routing/email/outbound/domains/{domainId}/activation":{"get":{"tags":["Routing"],"summary":"Get activation status (cname + dkim) of an outbound domain","description":"","operationId":"getRoutingEmailOutboundDomainActivation","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailOutboundDomainResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailOutboundDomainActivation"},"put":{"tags":["Routing"],"summary":"Request an activation status (cname + dkim) update of an outbound domain","description":"","operationId":"putRoutingEmailOutboundDomainActivation","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailOutboundDomainResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"putRoutingEmailOutboundDomainActivation"}},"/api/v2/routing/email/outbound/domains":{"get":{"tags":["Routing"],"summary":"Get outbound domains","description":"","operationId":"getRoutingEmailOutboundDomains","produces":["application/json"],"parameters":[{"name":"filter","in":"query","description":"Optional search filter","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"Get domains request timed out.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailOutboundDomains"},"post":{"tags":["Routing"],"summary":"Create a domain","description":"","operationId":"postRoutingEmailOutboundDomains","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Domain","required":true,"schema":{"$ref":"#/definitions/OutboundDomain"}}],"responses":{"202":{"description":"Creation request was successful. Need to wait for creation to complete","schema":{"$ref":"#/definitions/EmailOutboundDomainResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.exists":"The outbound domain already exists.","postino.max.domains.exceeded":"The maximum number of domains for the org has been exceeded.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.invalid.domain.name":"The 'domain' field contains some illegal characters.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailOutboundDomains"}},"/api/v2/routing/email/domains/{domainName}/routes/{routeId}":{"get":{"tags":["Routing"],"summary":"Get a route","description":"","operationId":"getRoutingEmailDomainRoute","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","in":"path","description":"route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomainRoute"},"put":{"tags":["Routing"],"summary":"Update a route","description":"","operationId":"putRoutingEmailDomainRoute","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","in":"path","description":"route ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Route","required":true,"schema":{"$ref":"#/definitions/InboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"reply.route.id.required":"A route ID is required for the reply email address.","postino.max.autobcc.exceeded":"The maximum number of automatic bcc email addresses for the route has been exceeded.","bad.request":"The request could not be understood by the server due to malformed syntax.","postino.invalid.route":"The 'queue' and 'pattern' fields are required.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","postino.error.bad.address":"Invalid email address. Check for invalid control or whitespace characters.","postino.error.invalid.signature.id":"The signature id is not valid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bad.flow.id":"The flow is not eligible for use here.","postino.error.queue.required":"A queue id or flow id is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","postino.error.invalid.signature.type":"The signature type is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.signature.not.found":"The signature was not found.","postino.signature.body.not.found":"The signature body was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"putRoutingEmailDomainRoute"},"delete":{"tags":["Routing"],"summary":"Delete a route","description":"","operationId":"deleteRoutingEmailDomainRoute","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","in":"path","description":"route ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The inbound route delete request timed out.","postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.route.conflict":"The inbound route is a reply route in one or more other inbound routes."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"deleteRoutingEmailDomainRoute"}},"/api/v2/routing/email/domains/{domainName}/routes":{"get":{"tags":["Routing"],"summary":"Get routes","description":"","operationId":"getRoutingEmailDomainRoutes","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pattern","in":"query","description":"Filter routes by the route's pattern property","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRouteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomainRoutes"},"post":{"tags":["Routing"],"summary":"Create a route","description":"","operationId":"postRoutingEmailDomainRoutes","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"in":"body","name":"body","description":"Route","required":true,"schema":{"$ref":"#/definitions/InboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.max.routes.exceeded":"The maximum number of routes for the domain has been exceeded.","reply.route.id.required":"A route ID is required for the reply email address.","postino.max.autobcc.exceeded":"The maximum number of automatic bcc email addresses for the route has been exceeded.","bad.request":"The request could not be understood by the server due to malformed syntax.","postino.invalid.route":"The 'queue' and 'pattern' fields are required.","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.error.not.found":"The resource could not be found.","constraint.validation":"%s","postino.domain.exists":"The inbound domain already exists.","postino.error.bad.address":"Invalid email address. Check for invalid control or whitespace characters.","postino.error.invalid.signature.id":"The signature id is not valid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bad.flow.id":"The flow is not eligible for use here.","postino.route.pattern.exists":"A route already exists for this domain with the specified pattern.","postino.error.queue.required":"A queue id or flow id is required.","postino.route.not.found":"The route could not be found.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","postino.error.invalid.signature.type":"The signature type is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.signature.not.found":"The signature was not found.","postino.signature.body.not.found":"The signature body was not found.","postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailDomainRoutes"}},"/api/v2/routing/email/outbound/domains/simulated":{"post":{"tags":["Routing"],"summary":"Create a simulated domain","description":"","operationId":"postRoutingEmailOutboundDomainsSimulated","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Domain","required":true,"schema":{"$ref":"#/definitions/OutboundDomain"}}],"responses":{"202":{"description":"Creation request was successful. Need to wait for creation to complete","schema":{"$ref":"#/definitions/EmailOutboundDomainResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.exists":"The outbound domain already exists.","postino.max.domains.exceeded":"The maximum number of domains for the org has been exceeded.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.invalid.domain.name":"The 'domain' field contains some illegal characters.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailOutboundDomainsSimulated"}},"/api/v2/routing/message/recipients/{recipientId}":{"get":{"tags":["Routing"],"summary":"Get a recipient","description":"","operationId":"getRoutingMessageRecipient","produces":["application/json"],"parameters":[{"name":"recipientId","in":"path","description":"Recipient ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recipient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:message:manage"]},"x-purecloud-method-name":"getRoutingMessageRecipient"},"put":{"tags":["Routing"],"summary":"Update a recipient","description":"","operationId":"putRoutingMessageRecipient","produces":["application/json"],"parameters":[{"name":"recipientId","in":"path","description":"Recipient ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Recipient","required":true,"schema":{"$ref":"#/definitions/RecipientRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recipient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.flow":"The flow was invalid.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:message:manage"]},"x-purecloud-method-name":"putRoutingMessageRecipient"}},"/api/v2/routing/message/recipients":{"get":{"tags":["Routing"],"summary":"Get recipients","description":"","operationId":"getRoutingMessageRecipients","produces":["application/json"],"parameters":[{"name":"messengerType","in":"query","description":"Messenger Type","required":false,"type":"string","enum":["sms","facebook","twitter","whatsapp","open","instagram"]},{"name":"name","in":"query","description":"Recipient Name","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecipientListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:message:manage"]},"x-purecloud-method-name":"getRoutingMessageRecipients"}},"/api/v2/routing/sms/addresses/{addressId}":{"get":{"tags":["Routing"],"summary":"Get an Address by Id for SMS","description":"","operationId":"getRoutingSmsAddress","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsAddress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsAddress"},"delete":{"tags":["Routing"],"summary":"Delete an Address by Id for SMS","description":"","operationId":"deleteRoutingSmsAddress","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:delete"]},"x-purecloud-method-name":"deleteRoutingSmsAddress"}},"/api/v2/routing/sms/addresses":{"get":{"tags":["Routing"],"summary":"Get a list of Addresses for SMS","description":"","operationId":"getRoutingSmsAddresses","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsAddressEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsAddresses"},"post":{"tags":["Routing"],"summary":"Provision an Address for SMS","description":"","operationId":"postRoutingSmsAddresses","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SmsAddress","required":true,"schema":{"$ref":"#/definitions/SmsAddressProvision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsAddress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.address":"The address you have provided cannot be validated. This may be due to spelling error or that the address is not available in a third-party data source for validation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:add"]},"x-purecloud-method-name":"postRoutingSmsAddresses"}},"/api/v2/routing/sms/availablephonenumbers":{"get":{"tags":["Routing"],"summary":"Get a list of available phone numbers for SMS provisioning.","description":"This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.","operationId":"getRoutingSmsAvailablephonenumbers","produces":["application/json"],"parameters":[{"name":"countryCode","in":"query","description":"The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned","required":true,"type":"string"},{"name":"region","in":"query","description":"Region/province/state that can be used to restrict the numbers returned","required":false,"type":"string"},{"name":"city","in":"query","description":"City that can be used to restrict the numbers returned","required":false,"type":"string"},{"name":"areaCode","in":"query","description":"Area code that can be used to restrict the numbers returned","required":false,"type":"string"},{"name":"phoneNumberType","in":"query","description":"Type of available phone numbers searched","required":true,"type":"string","enum":["local","mobile","tollfree"]},{"name":"pattern","in":"query","description":"A pattern to match phone numbers. Valid characters are '*' and [0-9a-zA-Z]. The '*' character will match any single digit.","required":false,"type":"string"},{"name":"addressRequirement","in":"query","description":"This indicates whether the phone number requires to have an Address registered.","required":false,"type":"string","enum":["none","any","local","foreign"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SMSAvailablePhoneNumberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:add"]},"x-purecloud-method-name":"getRoutingSmsAvailablephonenumbers"}},"/api/v2/routing/sms/phonenumbers/import":{"post":{"tags":["Routing"],"summary":"Imports a phone number for SMS","description":"","operationId":"postRoutingSmsPhonenumbersImport","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SmsPhoneNumber","required":true,"schema":{"$ref":"#/definitions/SmsPhoneNumberImport"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"202":{"description":"Accepted - the phone number imported is in progress.","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"phone.number.unavailable":"Phone number is unavailable.","bad.request":"Bad request provisioning phone number for SMS","invalid.property":"Value [%s] is not a valid property for object [%s]","missing.required.field.value":"A required field was not provided or is blank.","constraint.validation":"%s","unexpected.country.code":"The country code does not match the expected country code for this address.","phone.number.duplicate":"Phone number has already been created.","unexpected.phone.number.type":"The phone number type does not match the expected type for this address.","compliance.not.configurable":"Compliance is not configurable for current phone type.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.phone.number":"The phone number address is not in E.164 phone format.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"provisioning.action.in.progress":"A provisioning action is already in progress for this phone number"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:byoImport"]},"x-purecloud-method-name":"postRoutingSmsPhonenumbersImport"}},"/api/v2/routing/sms/phonenumbers/{addressId}":{"get":{"tags":["Routing"],"summary":"Get a phone number provisioned for SMS.","description":"","operationId":"getRoutingSmsPhonenumber","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand response with additional information","required":false,"type":"string","enum":["compliance","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsPhonenumber"},"put":{"tags":["Routing"],"summary":"Update a phone number provisioned for SMS.","description":"","operationId":"putRoutingSmsPhonenumber","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SmsPhoneNumber","required":true,"schema":{"$ref":"#/definitions/SmsPhoneNumber"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"202":{"description":"Accepted - The phone number update is in progress.","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.short.code.operation":"Phone number Update operation not allowed for phone number of type shortcode.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"provisioning.action.in.progress":"A provisioning action is already in progress for this phone number"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:edit"]},"x-purecloud-method-name":"putRoutingSmsPhonenumber"},"delete":{"tags":["Routing"],"summary":"Delete a phone number provisioned for SMS.","description":"","operationId":"deleteRoutingSmsPhonenumber","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted -The phone number delete is in progress."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.short.code.operation":"Phone number Delete operation not allowed for phone number of type shortcode.","recipient.has.flow":"Phone number cannot be deleted with an existing flow associated to it. Remove associated flow before deleting phone number.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"provisioning.action.in.progress":"A provisioning action is already in progress for this phone number"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:delete"]},"x-purecloud-method-name":"deleteRoutingSmsPhonenumber"}},"/api/v2/routing/sms/phonenumbers":{"get":{"tags":["Routing"],"summary":"Get a list of provisioned phone numbers.","description":"","operationId":"getRoutingSmsPhonenumbers","produces":["application/json"],"parameters":[{"name":"phoneNumber","in":"query","description":"Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used.","required":false,"type":"string"},{"name":"phoneNumberType","in":"query","description":"Filter on phone number type","required":false,"type":"array","items":{"type":"string","enum":["local","mobile","tollfree","shortcode","alphanumeric"]},"collectionFormat":"multi"},{"name":"phoneNumberStatus","in":"query","description":"Filter on phone number status","required":false,"type":"array","items":{"type":"string","enum":["active","invalid","initiated","porting","pending","pending-cancellation"]},"collectionFormat":"multi"},{"name":"countryCode","in":"query","description":"Filter on country code","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Optional field to sort results","required":false,"type":"string","enum":["phoneNumber","countryCode","country","dateCreated","dateModified","phoneNumberStatus","phoneNumberType","purchaseDate","supportsMms","supportsSms","supportsVoice"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","enum":["ascending","descending"]},{"name":"language","in":"query","description":"A language tag (which is sometimes referred to as a \"locale identifier\") to use to localize country field and sort operations","required":false,"type":"string","default":"en-US","x-example":"en-US"},{"name":"integration.id","in":"query","description":"Filter on the Genesys Cloud integration id to which the phone number belongs to","required":false,"type":"string"},{"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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsPhonenumbers"},"post":{"tags":["Routing"],"summary":"Provision a phone number for SMS","description":"","operationId":"postRoutingSmsPhonenumbers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SmsPhoneNumber","required":true,"schema":{"$ref":"#/definitions/SmsPhoneNumberProvision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"202":{"description":"Accepted - the phone number create is in progress.","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"phone.number.unavailable":"Phone number is unavailable.","bad.request":"The request could not be understood by the server due to malformed syntax.","requires.an.address":"The country associated with this phone number requires an address on file. To provision this number you must have an Address on your account.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","unexpected.country.code":"The country code does not match the expected country code for this address.","phone.number.duplicate":"Phone number has already been created.","unexpected.phone.number.type":"The phone number type does not match the expected type for this address.","requires.verified.identity.document":"This phone number requires a verified identity document, which is not supported.","requires.local.address":"Phone number associated with the country code requires a local address. To provision this number you must have an Address on your account which satisfies the local address requirements.","invalid.short.code.operation":"Phone number Provision operation not allowed for phone number of type shortcode.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","phone.number.requires.a.bundle":"This phone number cannot be provisioned without an identity document, which is not supported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Bad request provisioning phone number for SMS","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"provisioning.action.in.progress":"A provisioning action is already in progress for this phone number"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:add"]},"x-purecloud-method-name":"postRoutingSmsPhonenumbers"}},"/api/v2/routing/predictors/{predictorId}":{"get":{"tags":["Routing"],"summary":"Retrieve a single predictor.","description":"","operationId":"getRoutingPredictor","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"Predictor ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Predictor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"predictor.not.found":"Predictor not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:predictor:view"]},"x-purecloud-method-name":"getRoutingPredictor"},"delete":{"tags":["Routing"],"summary":"Delete single predictor.","description":"","operationId":"deleteRoutingPredictor","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"Predictor ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"Unable to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:predictor:delete","routing:queue:edit"]},"x-purecloud-method-name":"deleteRoutingPredictor"},"patch":{"tags":["Routing"],"summary":"Update single predictor.","description":"","operationId":"patchRoutingPredictor","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"Predictor ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchPredictorRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Predictor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"Unable to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:predictor:edit","routing:queue:edit"]},"x-purecloud-method-name":"patchRoutingPredictor"}},"/api/v2/routing/predictors":{"get":{"tags":["Routing"],"summary":"Retrieve all predictors.","description":"","operationId":"getRoutingPredictors","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"queueId","in":"query","description":"Comma-separated list of queue Ids to filter by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PredictorListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:predictor:view","routing:queue:view"]},"x-purecloud-method-name":"getRoutingPredictors"},"post":{"tags":["Routing"],"summary":"Create a predictor.","description":"","operationId":"postRoutingPredictors","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreatePredictorRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Predictor"}},"201":{"description":"Predictor created.","schema":{"$ref":"#/definitions/Predictor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","too.many.predictors":"Number of predictors exceeds the allowed limit.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"Unable to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:predictor:add","routing:queue:edit"]},"x-purecloud-method-name":"postRoutingPredictors"}},"/api/v2/routing/predictors/keyperformanceindicators":{"get":{"tags":["Routing"],"summary":"Get a list of Key Performance Indicators","description":"","operationId":"getRoutingPredictorsKeyperformanceindicators","produces":["application/json"],"parameters":[{"name":"kpiGroup","in":"query","description":"The Group of Key Performance Indicators to return","required":false,"type":"string","enum":["Standard","Custom"]},{"name":"expand","in":"query","description":"Parameter to request additional data to return in KPI payload","required":false,"type":"array","items":{"type":"string","enum":["queues"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/KeyPerformanceIndicator"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:keyPerformanceIndicator:view"]},"x-purecloud-method-name":"getRoutingPredictorsKeyperformanceindicators"}},"/api/v2/routing/predictors/{predictorId}/models/{modelId}/features":{"get":{"tags":["Routing"],"summary":"Retrieve Predictor Model Features.","description":"","operationId":"getRoutingPredictorModelFeatures","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"Predictor ID","required":true,"type":"string"},{"name":"modelId","in":"path","description":"Model ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PredictorModelFeatureListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Predictor Model was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:predictorModelFeature:view"]},"x-purecloud-method-name":"getRoutingPredictorModelFeatures"}},"/api/v2/routing/predictors/{predictorId}/models":{"get":{"tags":["Routing"],"summary":"Retrieve Predictor Models and Top Features.","description":"","operationId":"getRoutingPredictorModels","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"Predictor ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PredictorModels"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"predictor.not.found":"Predictor not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:predictorModel:view"]},"x-purecloud-method-name":"getRoutingPredictorModels"}},"/api/v2/routing/queues/{queueId}/members/{memberId}":{"delete":{"tags":["Routing"],"summary":"Delete a queue member.","description":"","operationId":"deleteRoutingQueueMember","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.type":"Group-type queue members cannot be individually deleted.","invalid.id":"A non-UUID value was specified for an ID field."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"deleteRoutingQueueMember"},"patch":{"tags":["Routing"],"summary":"Update the ring number OR joined status for a queue member.","description":"","operationId":"patchRoutingQueueMember","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Member","required":true,"schema":{"$ref":"#/definitions/QueueMember"}}],"responses":{"202":{"description":"User update has been accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure the joined OR ringNumber property is specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueMember"}},"/api/v2/routing/queues/{queueId}/members":{"get":{"tags":["Routing"],"summary":"Get the members of this queue.","description":"","operationId":"getRoutingQueueMembers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Max value is 100","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Note: results are sorted by name.","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Filter by queue member name (contains-style search)","required":false,"type":"string"},{"name":"profileSkills","in":"query","description":"Filter by profile skill (contains-style search)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"skills","in":"query","description":"Filter by skill (contains-style search)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"languages","in":"query","description":"Filter by language (contains-style search)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"routingStatus","in":"query","description":"Filter by routing status","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"presence","in":"query","description":"Filter by presence","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"memberBy","in":"query","description":"Filter by member type","required":false,"type":"string","enum":["user","group"]},{"name":"joined","in":"query","description":"Filter by joined status","required":false,"type":"boolean","enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.service.error":"The server is currently unable to handle the request .","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view","routing:queue:edit","routing:queue:readonly","routing:queueMember:manage"]},"x-purecloud-method-name":"getRoutingQueueMembers"},"post":{"tags":["Routing"],"summary":"Bulk add or delete up to 100 queue members","description":"","operationId":"postRoutingQueueMembers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WritableEntity"}}},{"name":"delete","in":"query","description":"True to delete queue members","required":false,"type":"boolean","default":false}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure you submit a valid number of queue members.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","queue.size.limit":"Adding all requested members would exceed queue member limit.","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"postRoutingQueueMembers"},"patch":{"tags":["Routing"],"summary":"Join or unjoin a set of users for a queue","description":"","operationId":"patchRoutingQueueMembers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure a valid number of queue members was submitted, and all have the joined property specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueMembers"}},"/api/v2/routing/queues/{queueId}/users/{memberId}":{"delete":{"tags":["Routing"],"summary":"DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member.","description":"","operationId":"deleteRoutingQueueUser","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.type":"Group-type queue members cannot be individually deleted.","invalid.id":"A non-UUID value was specified for an ID field."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"deleteRoutingQueueUser"},"patch":{"tags":["Routing"],"summary":"DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue.","description":"","operationId":"patchRoutingQueueUser","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Member","required":true,"schema":{"$ref":"#/definitions/QueueMember"}}],"responses":{"202":{"description":"User update has been accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure the joined OR ringNumber property is specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueUser"}},"/api/v2/routing/queues/{queueId}/users":{"get":{"tags":["Routing"],"summary":"DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue.","description":"","operationId":"getRoutingQueueUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Max value is 100","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Note: results are sorted by name.","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"},{"name":"joined","in":"query","description":"Filter by joined status","required":false,"type":"boolean"},{"name":"name","in":"query","description":"Filter by queue member name","required":false,"type":"string"},{"name":"profileSkills","in":"query","description":"Filter by profile skill","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"skills","in":"query","description":"Filter by skill","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"languages","in":"query","description":"Filter by language","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"routingStatus","in":"query","description":"Filter by routing status","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"presence","in":"query","description":"Filter by presence","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListingV1"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.service.error":"The server is currently unable to handle the request .","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view","routing:queueMember:manage"]},"x-purecloud-method-name":"getRoutingQueueUsers"},"post":{"tags":["Routing"],"summary":"DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members.","description":"","operationId":"postRoutingQueueUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WritableEntity"}}},{"name":"delete","in":"query","description":"True to delete queue members","required":false,"type":"boolean","default":false}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure you submit a valid number of queue members.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","queue.size.limit":"Adding all requested members would exceed queue member limit.","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"postRoutingQueueUsers"},"patch":{"tags":["Routing"],"summary":"DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue.","description":"","operationId":"patchRoutingQueueUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListingV1"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure a valid number of queue members was submitted, and all have the joined property specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueUsers"}},"/api/v2/routing/queues/{queueId}/comparisonperiods/{comparisonPeriodId}":{"get":{"tags":["Routing"],"summary":"Get a Comparison Period.","description":"","operationId":"getRoutingQueueComparisonperiod","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue id","required":true,"type":"string"},{"name":"comparisonPeriodId","in":"path","description":"ComparisonPeriod id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ComparisonPeriod"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"comparisonperiod.not.found":"Comparison Period not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:comparisonPeriod:view","routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueComparisonperiod"}},"/api/v2/routing/queues/{queueId}/comparisonperiods":{"get":{"tags":["Routing"],"summary":"Get list of comparison periods","description":"","operationId":"getRoutingQueueComparisonperiods","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ComparisonPeriodListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:comparisonPeriod:view","routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueComparisonperiods"}},"/api/v2/routing/skillgroups/{skillGroupId}/members/divisions":{"get":{"tags":["Routing"],"summary":"Get list of member divisions for this skill group.","description":"","operationId":"getRoutingSkillgroupMembersDivisions","produces":["application/json"],"parameters":[{"name":"skillGroupId","in":"path","description":"Skill Group ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand the name on each user","required":false,"type":"string","enum":["entities"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillGroupMemberDivisionList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:view"]},"x-purecloud-method-name":"getRoutingSkillgroupMembersDivisions"},"post":{"tags":["Routing"],"summary":"Add or remove member divisions for this skill group.","description":"","operationId":"postRoutingSkillgroupMembersDivisions","produces":["application/json"],"parameters":[{"name":"skillGroupId","in":"path","description":"Skill Group ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SkillGroupMemberDivisions"}}],"responses":{"204":{"description":"Success, skill group member division(s) were added and/or removed."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skillGroup:add"]},"x-purecloud-method-name":"postRoutingSkillgroupMembersDivisions"}},"/api/v2/routing/skillgroups/{skillGroupId}":{"get":{"tags":["Routing"],"summary":"Get skill group","description":"","operationId":"getRoutingSkillgroup","produces":["application/json"],"parameters":[{"name":"skillGroupId","in":"path","description":"Skill Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:view"]},"x-purecloud-method-name":"getRoutingSkillgroup"},"delete":{"tags":["Routing"],"summary":"Remove skill group definition","description":"","operationId":"deleteRoutingSkillgroup","produces":["application/json"],"parameters":[{"name":"skillGroupId","in":"path","description":"Skill Group ID","required":true,"type":"string"}],"responses":{"204":{"description":"Success, skill group was removed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:delete"]},"x-purecloud-method-name":"deleteRoutingSkillgroup"},"patch":{"tags":["Routing"],"summary":"Update skill group definition","description":"","operationId":"patchRoutingSkillgroup","produces":["application/json"],"parameters":[{"name":"skillGroupId","in":"path","description":"Skill Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Update skill groups","required":true,"schema":{"$ref":"#/definitions/SkillGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Provided request is not valid","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:edit"]},"x-purecloud-method-name":"patchRoutingSkillgroup"}},"/api/v2/routing/skillgroups/{skillGroupId}/members":{"get":{"tags":["Routing"],"summary":"Get skill group members","description":"","operationId":"getRoutingSkillgroupMembers","produces":["application/json"],"parameters":[{"name":"skillGroupId","in":"path","description":"Skill Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"after","in":"query","description":"The cursor that points to the next item","required":false,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the previous item","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand the name on each user","required":false,"type":"string","enum":["entities"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillGroupMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:view"]},"x-purecloud-method-name":"getRoutingSkillgroupMembers"}},"/api/v2/routing/skillgroups":{"get":{"tags":["Routing"],"summary":"Get skill group listing","description":"","operationId":"getRoutingSkillgroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Return only skill group names whose names start with this value (case-insensitive matching)","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the next item","required":false,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the previous item","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:view"]},"x-purecloud-method-name":"getRoutingSkillgroups"},"post":{"tags":["Routing"],"summary":"Create a skill group","description":"","operationId":"postRoutingSkillgroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create skill group","required":true,"schema":{"$ref":"#/definitions/SkillGroupWithMemberDivisions"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillGroupWithMemberDivisions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","group.name.in.use":"Skill Group with specified name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skillGroup:add"]},"x-purecloud-method-name":"postRoutingSkillgroups"}},"/api/v2/routing/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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested 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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage","routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUserUtilization"},"put":{"tags":["Routing","Users"],"summary":"Update the user's max utilization settings. Include only those media types requiring custom configuration.","description":"","operationId":"putRoutingUserUtilization","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"utilization","required":true,"schema":{"$ref":"#/definitions/UtilizationRequest"}}],"responses":{"200":{"description":"Operation was successful.","schema":{"$ref":"#/definitions/AgentMaxUtilizationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"An unsupported media type was specified.","interrupt.same.media.type":"A media type cannot be set up to interrupt itself.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.utilization.tag":"Invalid utilization tag provided.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.media.capacity":"Maximum capacity must be between 1 and 50.","invalid.id":"A non-UUID value was specified for an ID field.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Conflict updating user utilization. Another update took place at the same time. Please try again."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"putRoutingUserUtilization"},"delete":{"tags":["Routing","Users"],"summary":"Delete the user's max utilization settings and revert to the organization-wide default.","description":"","operationId":"deleteRoutingUserUtilization","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.id":"A non-UUID value was specified for an ID field."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The user was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Conflict updating user utilization. Another update took place at the same time. Please try again."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"deleteRoutingUserUtilization"}},"/api/v2/routing/wrapupcodes/divisionviews/{codeId}":{"get":{"tags":["Routing"],"summary":"Get a simplified wrap-up code.","description":"","operationId":"getRoutingWrapupcodesDivisionview","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:search"]},"x-purecloud-method-name":"getRoutingWrapupcodesDivisionview"}},"/api/v2/routing/wrapupcodes/divisionviews":{"get":{"tags":["Routing"],"summary":"Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s).","description":"Specifying both name and ID parameters is not supported.","operationId":"getRoutingWrapupcodesDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name (trailing asterisks allowed)","required":false,"type":"string"},{"name":"id","in":"query","description":"Wrapup code ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"includeState","in":"query","description":"Wrapup code state(s) to include","required":false,"type":"string","enum":["Active","Deleted","ActiveAndDeleted"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCodeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","name.and.id.specified":"Both name and ID were specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:search"]},"x-purecloud-method-name":"getRoutingWrapupcodesDivisionviews"}},"/api/v2/routing/wrapupcodes/{codeId}":{"get":{"tags":["Routing"],"summary":"Get details about this wrap-up code.","description":"","operationId":"getRoutingWrapupcode","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"You do not have the required permission for this operation.","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:view"]},"x-purecloud-method-name":"getRoutingWrapupcode"},"put":{"tags":["Routing"],"summary":"Update wrap-up code","description":"","operationId":"putRoutingWrapupcode","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"},{"in":"body","name":"body","description":"WrapupCode","required":true,"schema":{"$ref":"#/definitions/WrapupCodeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.name":"Invalid wrapup code name specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"A wrapup code with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"You do not have the required permission for this operation.","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:edit"]},"x-purecloud-method-name":"putRoutingWrapupcode"},"delete":{"tags":["Routing"],"summary":"Delete wrap-up code","description":"","operationId":"deleteRoutingWrapupcode","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.id":"A non-UUID value was specified for an ID field."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"You do not have the required permission for this operation.","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:delete"]},"x-purecloud-method-name":"deleteRoutingWrapupcode"}},"/api/v2/routing/wrapupcodes":{"get":{"tags":["Routing"],"summary":"Get list of wrapup codes.","description":"","operationId":"getRoutingWrapupcodes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name","enum":["name","id"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Wrapup code's name ('Sort by' param is ignored unless this field is provided)","required":false,"type":"string"},{"name":"id","in":"query","description":"Filter by wrapup code ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Filter by division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCodeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:view"]},"x-purecloud-method-name":"getRoutingWrapupcodes"},"post":{"tags":["Routing"],"summary":"Create a wrap-up code","description":"","operationId":"postRoutingWrapupcodes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"WrapupCode","required":true,"schema":{"$ref":"#/definitions/WrapupCodeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.name":"Invalid wrapup code name specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"A wrapup code with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"You do not have the required permission for this operation.","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"A referenced resource, such as a division, was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:add"]},"x-purecloud-method-name":"postRoutingWrapupcodes"}},"/api/v2/scim/resourcetypes/{resourceType}":{"get":{"tags":["SCIM"],"summary":"Get a resource type","description":"","operationId":"getScimResourcetype","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"resourceType","in":"path","description":"The type of resource. Returned with GET /api/v2/scim/resourcetypes.","required":true,"type":"string","enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimResourcetype"}},"/api/v2/scim/resourcetypes":{"get":{"tags":["SCIM"],"summary":"Get a list of resource types","description":"","operationId":"getScimResourcetypes","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceTypesListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimResourcetypes"}},"/api/v2/scim/schemas/{schemaId}":{"get":{"tags":["SCIM"],"summary":"Get a SCIM schema","description":"","operationId":"getScimSchema","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"schemaId","in":"path","description":"The ID of a schema. Returned with GET /api/v2/scim/schemas.","required":true,"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType","urn:ietf:params:scim:schemas:core:2.0:Schema","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimSchema"}},"/api/v2/scim/schemas":{"get":{"tags":["SCIM"],"summary":"Get a list of SCIM schemas","description":"","operationId":"getScimSchemas","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"filter","in":"query","description":"Filtered results are invalid and return 403 Unauthorized.","required":false,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimSchemas"}},"/api/v2/scim/groups":{"get":{"tags":["SCIM"],"summary":"Get a list of groups","description":"","operationId":"getScimGroups","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".","required":false,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimGroupListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimGroups"}},"/api/v2/scim/groups/{groupId}":{"get":{"tags":["SCIM"],"summary":"Get a group","description":"","operationId":"getScimGroup","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/groups.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The requested resource was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimGroup"},"put":{"tags":["SCIM"],"summary":"Replace a group","description":"","operationId":"putScimGroup","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2Group"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"putScimGroup"},"patch":{"tags":["SCIM"],"summary":"Modify a group","description":"","operationId":"patchScimGroup","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"patchScimGroup"}},"/api/v2/scim/serviceproviderconfig":{"get":{"tags":["SCIM"],"summary":"Get a service provider's configuration","description":"","operationId":"getScimServiceproviderconfig","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/serviceproviderconfig. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. ","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimServiceProviderConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimServiceproviderconfig"}},"/api/v2/scim/users":{"get":{"tags":["SCIM"],"summary":"Get a list of users","description":"To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".","operationId":"getScimUsers","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimUserListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimUsers"},"post":{"tags":["SCIM"],"summary":"Create a user","description":"","operationId":"postScimUsers","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"in":"body","name":"body","description":"The information used to create a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2CreateUser"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"201":{"description":"User Created.","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"User name already in use by non-deleted user.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:add","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign","telephony:extension:assign"]},"x-purecloud-method-name":"postScimUsers"}},"/api/v2/scim/users/{userId}":{"get":{"tags":["SCIM"],"summary":"Get a user","description":"","operationId":"getScimUser","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"A conflict occurred when getting a SCIM user"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The SCIM user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimUser"},"put":{"tags":["SCIM"],"summary":"Replace a user","description":"","operationId":"putScimUser","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2User"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign","telephony:extension:assign"]},"x-purecloud-method-name":"putScimUser"},"delete":{"tags":["SCIM"],"summary":"Delete a user","description":"","operationId":"deleteScimUser","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"User Deleted with no content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.conflict":"Version does not match current version."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:delete"]},"x-purecloud-method-name":"deleteScimUser"},"patch":{"tags":["SCIM"],"summary":"Modify a user","description":"","operationId":"patchScimUser","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign","telephony:extension:assign"]},"x-purecloud-method-name":"patchScimUser"}},"/api/v2/scim/v2/resourcetypes/{resourceType}":{"get":{"tags":["SCIM"],"summary":"Get a resource type","description":"","operationId":"getScimV2Resourcetype","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"resourceType","in":"path","description":"The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes.","required":true,"type":"string","enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Resourcetype"}},"/api/v2/scim/v2/resourcetypes":{"get":{"tags":["SCIM"],"summary":"Get a list of resource types","description":"","operationId":"getScimV2Resourcetypes","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceTypesListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Resourcetypes"}},"/api/v2/scim/v2/schemas/{schemaId}":{"get":{"tags":["SCIM"],"summary":"Get a SCIM schema","description":"","operationId":"getScimV2Schema","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"schemaId","in":"path","description":"The ID of a schema. Returned with GET /api/v2/scim/v2/schemas.","required":true,"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType","urn:ietf:params:scim:schemas:core:2.0:Schema","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Schema"}},"/api/v2/scim/v2/schemas":{"get":{"tags":["SCIM"],"summary":"Get a list of SCIM schemas","description":"","operationId":"getScimV2Schemas","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"filter","in":"query","description":"Filtered results are invalid and return 403 Unauthorized.","required":false,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Schemas"}},"/api/v2/scim/v2/groups":{"get":{"tags":["SCIM"],"summary":"Get a list of groups","description":"","operationId":"getScimV2Groups","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".","required":true,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimGroupListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimV2Groups"}},"/api/v2/scim/v2/groups/{groupId}":{"get":{"tags":["SCIM"],"summary":"Get a group","description":"","operationId":"getScimV2Group","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/v2/groups.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimV2Group"},"put":{"tags":["SCIM"],"summary":"Replace a group","description":"","operationId":"putScimV2Group","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/v2/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2Group"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"putScimV2Group"},"patch":{"tags":["SCIM"],"summary":"Modify a group","description":"","operationId":"patchScimV2Group","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/v2/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","org.disabled":"Unable to modify group due to the organization being disabled.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"patchScimV2Group"}},"/api/v2/scim/v2/serviceproviderconfig":{"get":{"tags":["SCIM"],"summary":"Get a service provider's configuration","description":"","operationId":"getScimV2Serviceproviderconfig","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/serviceproviderconfig. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. ","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimServiceProviderConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Serviceproviderconfig"}},"/api/v2/scim/v2/users":{"get":{"tags":["SCIM"],"summary":"Get a list of users","description":"To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".","operationId":"getScimV2Users","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimUserListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Users"},"post":{"tags":["SCIM"],"summary":"Create a user","description":"","operationId":"postScimV2Users","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"in":"body","name":"body","description":"The information used to create a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2CreateUser"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"201":{"description":"User Created.","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"User name already in use by non-deleted user.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:add","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign","telephony:extension:assign"]},"x-purecloud-method-name":"postScimV2Users"}},"/api/v2/scim/v2/users/{userId}":{"get":{"tags":["SCIM"],"summary":"Get a user","description":"","operationId":"getScimV2User","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"User could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.conflict":"Conflict with existing user ID."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2User"},"put":{"tags":["SCIM"],"summary":"Replace a user","description":"","operationId":"putScimV2User","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2User"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign","telephony:extension:assign"]},"x-purecloud-method-name":"putScimV2User"},"delete":{"tags":["SCIM"],"summary":"Delete a user","description":"","operationId":"deleteScimV2User","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"User Deleted with no content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:delete"]},"x-purecloud-method-name":"deleteScimV2User"},"patch":{"tags":["SCIM"],"summary":"Modify a user","description":"","operationId":"patchScimV2User","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign","telephony:extension:assign"]},"x-purecloud-method-name":"patchScimV2User"}},"/api/v2/search":{"get":{"tags":["Search","Suggest"],"summary":"Search using the q64 value returned from a previous search.","description":"","operationId":"getSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin","callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation","conversations","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"getSearch"},"post":{"tags":["Search","Suggest"],"summary":"Search resources.","description":"","operationId":"postSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/SearchRequest"}},{"name":"profile","in":"query","description":"profile","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","user.not.in.organization":"User is not in organization.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","jid.not.found":"Unable to determine the JID for user."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"postSearch"}},"/api/v2/search/suggest":{"get":{"tags":["Search","Suggest"],"summary":"Suggest resources using the q64 value returned from a previous suggest query.","description":"","operationId":"getSearchSuggest","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin","callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation","conversations","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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"getSearchSuggest"},"post":{"tags":["Search","Suggest"],"summary":"Suggest resources.","description":"","operationId":"postSearchSuggest","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/SuggestSearchRequest"}},{"name":"profile","in":"query","description":"profile","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"postSearchSuggest"}},"/api/v2/analytics/conversations/transcripts/query":{"post":{"tags":["Search","Analytics"],"summary":"Search resources.","description":"","operationId":"postAnalyticsConversationsTranscriptsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/TranscriptConversationDetailSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributesMultiGetResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"postAnalyticsConversationsTranscriptsQuery"}},"/api/v2/speechandtextanalytics/categories":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech and Text Analytics categories","description":"","operationId":"getSpeechandtextanalyticsCategories","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The page size for the listing. The max that will be returned is 50.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number for the listing","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"The category name filter applied to the listing","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"The sort order for the listing","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"sortBy","in":"query","description":"The field to sort by for the listing","required":false,"type":"string","default":"name","enum":["name","description"]},{"name":"ids","in":"query","description":"Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoriesEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:category:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsCategories"},"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics category","description":"","operationId":"postSpeechandtextanalyticsCategories","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The category to create","required":true,"schema":{"$ref":"#/definitions/CategoryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StaCategory"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/CategoryRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"category.criteria.depth.limit.exceeded":"Maximum level criteria limit exceeded","category.criteria.limit.exceeded":"Maximum criteria item limit exceeded","bad.request":"Wrong request structure","invalid.property":"Value [%s] is not a valid property for object [%s]","category.name.limit.exceeded":"Maximum category name character limit exceeded","constraint.validation":"%s","category.limit.exceeded":"Maximum categories limit exceeded","bad.criteria.logic":"Bad criteria logic","category.description.limit.exceeded":"Maximum category description character limit exceeded","category.term.character.limit.exceeded":"Maximum term character limit exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bad.criteria":"Wrong criteria structure","category.term.word.limit.exceeded":"Maximum term word limit exceeded","invalid.value":"Invalid data type","topic.not.found":"Given topic does not exist"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"category.conflict":"A category with the same name already exists in this organization"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:category:add"]},"x-purecloud-method-name":"postSpeechandtextanalyticsCategories"}},"/api/v2/speechandtextanalytics/categories/{categoryId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics Category by ID","description":"","operationId":"getSpeechandtextanalyticsCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"The id of the category","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StaCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"category.not.found":"The requested category could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:category:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsCategory"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update a Speech & Text Analytics category by ID","description":"","operationId":"putSpeechandtextanalyticsCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"The id of the category","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated category","required":true,"schema":{"$ref":"#/definitions/CategoryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StaCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"category.criteria.depth.limit.exceeded":"Maximum level criteria limit exceeded","category.criteria.limit.exceeded":"Maximum criteria item limit exceeded","bad.request":"Wrong request structure","invalid.property":"Value [%s] is not a valid property for object [%s]","category.name.limit.exceeded":"Maximum category name character limit exceeded","constraint.validation":"%s","bad.criteria.logic":"Bad criteria logic","category.description.limit.exceeded":"Maximum category description character limit exceeded","category.term.character.limit.exceeded":"Maximum term character limit exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bad.criteria":"Wrong criteria structure","category.term.word.limit.exceeded":"Maximum term word limit exceeded","invalid.value":"Invalid data type","topic.not.found":"Given topic does not exist"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"category.not.found":"The requested category could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"category.conflict":"A category with the same name already exists in this organization"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:category:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsCategory"},"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete a Speech & Text Analytics category by ID","description":"","operationId":"deleteSpeechandtextanalyticsCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"The id of the category","required":true,"type":"string"}],"responses":{"204":{"description":""},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:category:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsCategory"}},"/api/v2/speechandtextanalytics/conversations/{conversationId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get Speech and Text Analytics for a specific conversation","description":"","operationId":"getSpeechandtextanalyticsConversation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationMetrics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from retrieving Speech and Text Analytics.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Speech and Text Analytics Not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:recording:view","speechAndTextAnalytics:data:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsConversation"}},"/api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics dictionary feedback by id","description":"","operationId":"getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId","produces":["application/json"],"parameters":[{"name":"dictionaryFeedbackId","in":"path","description":"The Id of the Dictionary Feedback","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DictionaryFeedback"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dictionary.term.not.found":"The requested dictionary term could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:dictionaryterm:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update existing Speech & Text Analytics dictionary feedback by id","description":"","operationId":"putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId","produces":["application/json"],"parameters":[{"name":"dictionaryFeedbackId","in":"path","description":"The Id of the Dictionary Feedback","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DictionaryFeedback"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DictionaryFeedback"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"example.phrases.maximum.count.exceeded":"There must be least 3 and no more than 20 example phrases","example.phrases.contains.duplicate.phrase":"There should be no duplication phrases in the listed example phrases","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","example.phrase.minimum.words.required":"The example phrase should contain minimum 3 words & maximum 20 words","example.phrases.should.contain.term":"The term must appear in the example phrases listed","example.phrase.length.required":"The example phrase must be at least 3 characters long","constraint.validation":"%s","example.phrase.length.exceeded":"40 characters in a phrase limit exceeded","example.phrase.maximum.words.exceeded":"The example phrase should contain minimum 3 words & maximum 20 words","invalid.boost.value":"The boost value should range from 1.0 to 10.0","sounds.like.length.exceeded":"30 characters in a sounds like limit exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","sounds.like.contains.duplicate.value":"The sounds like contains duplicate entries","example.phrases.minimum.count.required":"There must be least 3 and no more than 20 example phrases","sounds.like.maximum.count.exceeded":"The maximum number of sounds like has been reached","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dictionary.term.not.found":"The requested dictionary term could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"term.update.not.allowed":"The term cannot be updated","dialect.update.not.allowed":"The dialect of term cannot be updated"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:dictionaryterm:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId"},"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete a Speech & Text Analytics DictionaryFeedback by Id","description":"","operationId":"deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId","produces":["application/json"],"parameters":[{"name":"dictionaryFeedbackId","in":"path","description":"The Id of the Dictionary Feedback","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:dictionaryterm:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId"}},"/api/v2/speechandtextanalytics/dictionaryfeedback":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics dictionary feedbacks","description":"","operationId":"getSpeechandtextanalyticsDictionaryfeedback","produces":["application/json"],"parameters":[{"name":"dialect","in":"query","description":"The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard","required":false,"type":"string","x-example":"en-US"},{"name":"nextPage","in":"query","description":"The key for listing the next page","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing","required":false,"type":"integer","default":500,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DictionaryFeedbackEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.not.found":"The requested page could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:dictionaryterm:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsDictionaryfeedback"},"post":{"tags":["Speech & Text Analytics"],"summary":"Create a Speech & Text Analytics DictionaryFeedback","description":"","operationId":"postSpeechandtextanalyticsDictionaryfeedback","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The DictionaryFeedback to create","required":true,"schema":{"$ref":"#/definitions/DictionaryFeedback"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/DictionaryFeedback"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"term.length.exceeded":"30 characters in a term limit exceeded","example.phrases.maximum.count.exceeded":"There must be least 3 and no more than 20 example phrases","example.phrases.contains.duplicate.phrase":"There should be no duplication phrases in the listed example phrases","bad.request":"Wrong request structure","invalid.property":"Value [%s] is not a valid property for object [%s]","example.phrase.minimum.words.required":"The example phrase should contain minimum 3 words & maximum 20 words","example.phrases.should.contain.term":"The term must appear in the example phrases listed","example.phrase.length.required":"The example phrase must be at least 3 characters long","constraint.validation":"%s","example.phrase.length.exceeded":"40 characters in a phrase limit exceeded","example.phrase.maximum.words.exceeded":"The example phrase should contain minimum 3 words & maximum 20 words","invalid.boost.value":"The boost value should range from 1.0 to 10.0","sounds.like.length.exceeded":"30 characters in a sounds like limit exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","sounds.like.contains.duplicate.value":"The sounds like contains duplicate entries","example.phrases.minimum.count.required":"There must be least 3 and no more than 20 example phrases","sounds.like.maximum.count.exceeded":"The maximum number of sounds like has been reached","invalid.dialect":"The dialect is not supported","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"term.limit.exceeded":"500 term quota exceeded for dialect in this Org","term.already.exists":"The term for the dialect already exists in this Org"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:dictionaryterm:add"]},"x-purecloud-method-name":"postSpeechandtextanalyticsDictionaryfeedback"}},"/api/v2/speechandtextanalytics/sentimentfeedback/{sentimentFeedbackId}":{"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete a Speech & Text Analytics SentimentFeedback by Id","description":"","operationId":"deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId","produces":["application/json"],"parameters":[{"name":"sentimentFeedbackId","in":"path","description":"The Id of the SentimentFeedback","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:feedback:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId"}},"/api/v2/speechandtextanalytics/sentimentfeedback":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics SentimentFeedback","description":"","operationId":"getSpeechandtextanalyticsSentimentfeedback","produces":["application/json"],"parameters":[{"name":"dialect","in":"query","description":"The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard","required":false,"type":"string","x-example":"en-US"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SentimentFeedbackEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:feedback:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsSentimentfeedback"},"post":{"tags":["Speech & Text Analytics"],"summary":"Create a Speech & Text Analytics SentimentFeedback","description":"","operationId":"postSpeechandtextanalyticsSentimentfeedback","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The SentimentFeedback to create","required":true,"schema":{"$ref":"#/definitions/SentimentFeedback"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/SentimentFeedback"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"phrase.logograph.length.required":"The phrase should contain minimum 1 char & maximum 40 chars","bad.request":"Wrong request structure","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","phrase.maximum.words.exceeded":"The phrase does not contain a minimum of 1 word that provide sufficient context, or contains too many words beyond 20 and is too specific.","invalid.feedbackValue":"The feedbackValue & initialValue cannot be same","phrase.length.exceeded":"500 characters in a phrase limit exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","phrase.minimum.words.required":"The phrase does not contain a minimum of 1 word that provide sufficient context, or contains too many words beyond 20 and is too specific.","phrase.logograph.length.exceeded":"The phrase should contain minimum 1 char & maximum 40 chars","invalid.dialect":"The dialect is not supported","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"feedback.limit.exceeded":"2000 feedback quota exceeded in this Org","phrase.already.exists":"Feedback with same phrase for the dialect already exists in this Org."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:feedback:add"]},"x-purecloud-method-name":"postSpeechandtextanalyticsSentimentfeedback"},"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete All Speech & Text Analytics SentimentFeedback","description":"","operationId":"deleteSpeechandtextanalyticsSentimentfeedback","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:feedback:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsSentimentfeedback"}},"/api/v2/speechandtextanalytics/programs/{programId}/transcriptionengines":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get transcription engine settings of a program","description":"","operationId":"getSpeechandtextanalyticsProgramTranscriptionengines","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramTranscriptionEngines"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramTranscriptionengines"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update transcription engine settings of a program","description":"","operationId":"putSpeechandtextanalyticsProgramTranscriptionengines","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"},{"in":"body","name":"body","description":"Program transcription engine setting","required":true,"schema":{"$ref":"#/definitions/TranscriptionEnginesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramTranscriptionEngines"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"transcriptionengine.limit.exceeded":"Exceeded maximum number of transcription engines quota","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dialect.duplicate":"Duplicated dialects","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Invalid Value"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsProgramTranscriptionengines"}},"/api/v2/speechandtextanalytics/programs/transcriptionengines/dialects":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get supported dialects for each transcription engine","description":"","operationId":"getSpeechandtextanalyticsProgramsTranscriptionenginesDialects","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedDialectsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-purecloud-method-name":"getSpeechandtextanalyticsProgramsTranscriptionenginesDialects"}},"/api/v2/speechandtextanalytics/sentiment/dialects":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics sentiment supported dialects","description":"","operationId":"getSpeechandtextanalyticsSentimentDialects","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-purecloud-method-name":"getSpeechandtextanalyticsSentimentDialects"}},"/api/v2/speechandtextanalytics/settings":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get Speech And Text Analytics Settings","description":"","operationId":"getSpeechandtextanalyticsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"settings.not.found":"The organization does not have SpeechAndTextAnalytics settings","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:settings:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsSettings"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update Speech And Text Analytics Settings","description":"","operationId":"putSpeechandtextanalyticsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Speech And Text Analytics Settings","required":true,"schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsRequest"}}],"responses":{"200":{"description":"Speech And Text Analytics settings has been updated","schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The input is not valid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:settings:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsSettings"},"patch":{"tags":["Speech & Text Analytics"],"summary":"Patch Speech And Text Analytics Settings","description":"","operationId":"patchSpeechandtextanalyticsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Speech And Text Analytics Settings","required":true,"schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsRequest"}}],"responses":{"200":{"description":"Speech And Text Analytics settings has been updated","schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The input is not valid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:settings:edit"]},"x-purecloud-method-name":"patchSpeechandtextanalyticsSettings"}},"/api/v2/speechandtextanalytics/conversations/{conversationId}/categories":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of detected Speech and Text Analytics categories of conversation","description":"","operationId":"getSpeechandtextanalyticsConversationCategories","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"The id of the conversation","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing. The max that will be returned is 50.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number for the listing","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationCategoriesEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested conversation could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:data:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsConversationCategories"}},"/api/v2/speechandtextanalytics/programs/general/jobs/{jobId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics general program job by id","description":"","operationId":"getSpeechandtextanalyticsProgramsGeneralJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the publish programs job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeneralProgramJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"job.not.found":"The requested job could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:add","speechAndTextAnalytics:program:edit","speechAndTextAnalytics:topic:add","speechAndTextAnalytics:topic:edit"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramsGeneralJob"}},"/api/v2/speechandtextanalytics/programs/general/jobs":{"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics general program job","description":"","operationId":"postSpeechandtextanalyticsProgramsGeneralJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The general programs job to create","required":true,"schema":{"$ref":"#/definitions/GeneralProgramJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeneralProgramJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"topics.limit.exceeded":"500 topics quota exceeded","programs.limit.exceeded":"100 programs quota exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dialect.not.found":"The requested dialect could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.program.job.already.running":"A General Program Job is already running"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:add","speechAndTextAnalytics:program:edit","speechAndTextAnalytics:topic:add","speechAndTextAnalytics:topic:edit"]},"x-purecloud-method-name":"postSpeechandtextanalyticsProgramsGeneralJobs"}},"/api/v2/speechandtextanalytics/topics/general":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the Speech & Text Analytics general topics for a given dialect","description":"","operationId":"getSpeechandtextanalyticsTopicsGeneral","produces":["application/json"],"parameters":[{"name":"dialect","in":"query","description":"The dialect of the general topics, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard","required":false,"type":"string","enum":["ar-001","ar-AE","ar-BH","ar-EG","ar-IL","ar-SA","ar-TN","da-DK","de-CH","de-DE","en-AU","en-GB","en-HK","en-IE","en-IN","en-NZ","en-SG","en-US","en-ZA","es-ES","es-US","fi-FI","fr-CA","fr-FR","he-IL","it-IT","ja-JP","ko-KR","nb-NO","nl-NL","pl-PL","pt-BR","pt-PT","sv-SE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeneralTopicsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dialect.not.found":"The requested dialect could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopicsGeneral"}},"/api/v2/speechandtextanalytics/programs/{programId}/mappings":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get Speech & Text Analytics program mappings to queues and flows by id","description":"","operationId":"getSpeechandtextanalyticsProgramMappings","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramMappings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramMappings"},"put":{"tags":["Speech & Text Analytics"],"summary":"Set Speech & Text Analytics program mappings to queues and flows","description":"","operationId":"putSpeechandtextanalyticsProgramMappings","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"},{"in":"body","name":"body","description":"The program to set mappings for","required":true,"schema":{"$ref":"#/definitions/ProgramMappingsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramMappings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.limit.exceeded":"500 flows limit exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","program.mappings.limit.exceeded":"20000 program mappings limit exceeded","constraint.validation":"%s","queues.limit.exceeded":"500 queues limit exceeded","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Queue / Flow with id {id} is already mapped to another program"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsProgramMappings"}},"/api/v2/speechandtextanalytics/programs/publishjobs/{jobId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics publish programs job by id","description":"","operationId":"getSpeechandtextanalyticsProgramsPublishjob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the publish programs job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"job.not.found":"The requested job could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:publish"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramsPublishjob"}},"/api/v2/speechandtextanalytics/programs/publishjobs":{"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics publish programs job","description":"","operationId":"postSpeechandtextanalyticsProgramsPublishjobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The publish programs job to create","required":true,"schema":{"$ref":"#/definitions/ProgramJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","programs.limit.exceeded":"Limit of 10 programs to publish exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","program.not.provided":"At least one Program Id should be provided","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:publish"]},"x-purecloud-method-name":"postSpeechandtextanalyticsProgramsPublishjobs"}},"/api/v2/speechandtextanalytics/programs/{programId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics program by id","description":"","operationId":"getSpeechandtextanalyticsProgram","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Program"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgram"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update existing Speech & Text Analytics program","description":"","operationId":"putSpeechandtextanalyticsProgram","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"},{"in":"body","name":"body","description":"The program to update","required":true,"schema":{"$ref":"#/definitions/ProgramRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Program"}},"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":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"A program with the same name already exists in this Org"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsProgram"},"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete a Speech & Text Analytics program by id","description":"","operationId":"deleteSpeechandtextanalyticsProgram","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"},{"name":"forceDelete","in":"query","description":"Indicates whether the program is forced to be deleted or not. Required when the program to delete is the default program.","required":false,"type":"boolean","default":false,"enum":["true","false"]}],"responses":{"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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsProgram"}},"/api/v2/speechandtextanalytics/programs/mappings":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics programs mappings to queues and flows","description":"","operationId":"getSpeechandtextanalyticsProgramsMappings","produces":["application/json"],"parameters":[{"name":"nextPage","in":"query","description":"The key for listing the next page","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing","required":false,"type":"integer","default":20,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramsMappingsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.not.found":"The requested page could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramsMappings"}},"/api/v2/speechandtextanalytics/programs":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics programs","description":"","operationId":"getSpeechandtextanalyticsPrograms","produces":["application/json"],"parameters":[{"name":"nextPage","in":"query","description":"The key for listing the next page","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing","required":false,"type":"integer","default":20,"format":"int32"},{"name":"state","in":"query","description":"Program state. Defaults to Latest","required":false,"type":"string","enum":["Latest","Published"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.not.found":"The requested page could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsPrograms"},"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics program","description":"","operationId":"postSpeechandtextanalyticsPrograms","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The program to create","required":true,"schema":{"$ref":"#/definitions/ProgramRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Program"}},"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":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"A program with the same name already exists in this Org"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:add"]},"x-purecloud-method-name":"postSpeechandtextanalyticsPrograms"}},"/api/v2/speechandtextanalytics/topics/publishjobs/{jobId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics publish topics job by id","description":"","operationId":"getSpeechandtextanalyticsTopicsPublishjob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the publish topics job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TopicJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"job.not.found":"The requested job could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:publish"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopicsPublishjob"}},"/api/v2/speechandtextanalytics/topics/publishjobs":{"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics publish topics job","description":"","operationId":"postSpeechandtextanalyticsTopicsPublishjobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The publish topics job to create","required":true,"schema":{"$ref":"#/definitions/TopicJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TopicJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"topics.limit.exceeded":"Limit of 50 topics to publish exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","topic.not.provided":"At least one Topic Id should be provided","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","topic.not.found":"The requested topic could not be found"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:publish"]},"x-purecloud-method-name":"postSpeechandtextanalyticsTopicsPublishjobs"}},"/api/v2/speechandtextanalytics/topics/{topicId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics topic by id","description":"","operationId":"getSpeechandtextanalyticsTopic","produces":["application/json"],"parameters":[{"name":"topicId","in":"path","description":"The id of the topic","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Topic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","topic.not.found":"The requested topic could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopic"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update existing Speech & Text Analytics topic","description":"","operationId":"putSpeechandtextanalyticsTopic","produces":["application/json"],"parameters":[{"name":"topicId","in":"path","description":"The id of the topic","required":true,"type":"string"},{"in":"body","name":"body","description":"The topic to update","required":true,"schema":{"$ref":"#/definitions/TopicRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Topic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"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":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Topic with the same name and dialect already exists in this Org"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsTopic"},"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete a Speech & Text Analytics topic by id","description":"","operationId":"deleteSpeechandtextanalyticsTopic","produces":["application/json"],"parameters":[{"name":"topicId","in":"path","description":"The id of the topic","required":true,"type":"string"}],"responses":{"204":{"description":"The topic was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"deleting.topic.used.in.category.is.forbidden":"The topic cannot be deleted. There are categories associated to it."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsTopic"}},"/api/v2/speechandtextanalytics/topics/dialects":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get list of supported Speech & Text Analytics topics dialects","description":"","operationId":"getSpeechandtextanalyticsTopicsDialects","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-purecloud-method-name":"getSpeechandtextanalyticsTopicsDialects"}},"/api/v2/speechandtextanalytics/topics":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics topics","description":"","operationId":"getSpeechandtextanalyticsTopics","produces":["application/json"],"parameters":[{"name":"nextPage","in":"query","description":"The key for listing the next page","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing. The max that will be returned is 500.","required":false,"type":"integer","default":20,"format":"int32"},{"name":"state","in":"query","description":"Topic state. Defaults to latest","required":false,"type":"string","enum":["latest","published"]},{"name":"name","in":"query","description":"Case insensitive partial name to filter by","required":false,"type":"string"},{"name":"ids","in":"query","description":"Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"dialects","in":"query","description":"Comma separated dialect strings to filter by. Maximum of 15 dialects allowed.","required":false,"type":"array","items":{"type":"string","enum":["en-US","es-US","en-AU","en-GB","en-ZA","es-ES","en-IN","fr-FR","fr-CA","it-IT","de-DE","pt-BR","pl-PL","pt-PT","nl-NL","ko-KR"]},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort results by. Defaults to name","required":false,"type":"string","enum":["name"]},{"name":"sortOrder","in":"query","description":"Sort order. Defaults to asc","required":false,"type":"string","enum":["asc","desc"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TopicsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.not.found":"The requested page could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopics"},"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics topic","description":"","operationId":"postSpeechandtextanalyticsTopics","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The topic to create","required":true,"schema":{"$ref":"#/definitions/TopicRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Topic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"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":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Topic with the same name and dialect already exists in this Org"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:add"]},"x-purecloud-method-name":"postSpeechandtextanalyticsTopics"}},"/api/v2/speechandtextanalytics/topics/general/status":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of general topics from the org and the system with their current status","description":"","operationId":"getSpeechandtextanalyticsTopicsGeneralStatus","produces":["application/json"],"parameters":[{"name":"dialect","in":"query","description":"The dialect of the general topics, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard","required":false,"type":"string","enum":["ar-001","ar-AE","ar-BH","ar-EG","ar-IL","ar-SA","ar-TN","da-DK","de-CH","de-DE","en-AU","en-GB","en-HK","en-IE","en-IN","en-NZ","en-SG","en-US","en-ZA","es-ES","es-US","fi-FI","fr-CA","fr-FR","he-IL","it-IT","ja-JP","ko-KR","nb-NO","nl-NL","pl-PL","pt-BR","pt-PT","sv-SE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnifiedGeneralTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dialect.not.found":"The requested dialect could not be found","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.supported.above.500.topics":"Out-of-the-box topics status api is not allowed over 500 topics"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopicsGeneralStatus"}},"/api/v2/speechandtextanalytics/programs/unpublished":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics unpublished programs","description":"","operationId":"getSpeechandtextanalyticsProgramsUnpublished","produces":["application/json"],"parameters":[{"name":"nextPage","in":"query","description":"The key for listing the next page","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing","required":false,"type":"integer","default":20,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnpublishedProgramsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.not.found":"The requested page could not be found","not.found":"The requested resource was not found."}},"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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramsUnpublished"}},"/api/v2/speechandtextanalytics/transcripts/search":{"post":{"tags":["Search","Speech & Text Analytics"],"summary":"Search resources.","description":"","operationId":"postSpeechandtextanalyticsTranscriptsSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/TranscriptSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly","speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","recording:recording:view"]},"x-purecloud-method-name":"postSpeechandtextanalyticsTranscriptsSearch"}},"/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the pre-signed S3 URL for the transcript of a specific communication of a conversation","description":"","operationId":"getSpeechandtextanalyticsConversationCommunicationTranscripturl","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"Communication ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptUrl"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from retrieving transcript url.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"URL is not available."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:recording:view","speechAndTextAnalytics:data:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsConversationCommunicationTranscripturl"}},"/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturls":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of pre-signed S3 URL for the transcripts of a specific communication of a conversation","description":"","operationId":"getSpeechandtextanalyticsConversationCommunicationTranscripturls","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"Communication ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptUrls"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from retrieving transcript urls.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"URL is not available."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsConversationCommunicationTranscripturls"}},"/api/v2/teams/{teamId}/members":{"get":{"tags":["Teams"],"summary":"Get team membership","description":"","operationId":"getTeamMembers","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"before","in":"query","description":"The cursor that points to the previous item in the complete list of teams","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the next item in the complete list of teams","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand the name on each user","required":false,"type":"string","enum":["entities"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TeamMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a team with that teamId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:view"]},"x-purecloud-method-name":"getTeamMembers"},"post":{"tags":["Teams"],"summary":"Add team members","description":"","operationId":"postTeamMembers","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"Team ID","required":true,"type":"string"},{"in":"body","name":"body","description":"TeamMembers","required":true,"schema":{"$ref":"#/definitions/TeamMembers"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TeamMemberAddListingResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a team ","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:assign"]},"x-purecloud-method-name":"postTeamMembers"},"delete":{"tags":["Teams"],"summary":"Delete team members","description":"","operationId":"deleteTeamMembers","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"id","in":"query","description":"Comma separated list of member ids to remove","required":true,"type":"string"}],"responses":{"204":{"description":"Success, team members are removed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","max.user.ids":"Only 25 members can be deleted at a time."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a team ","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:assign"]},"x-purecloud-method-name":"deleteTeamMembers"}},"/api/v2/teams/{teamId}":{"get":{"tags":["Teams"],"summary":"Get team","description":"","operationId":"getTeam","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Team"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:view"]},"x-purecloud-method-name":"getTeam"},"delete":{"tags":["Teams"],"summary":"Delete team","description":"","operationId":"deleteTeam","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"204":{"description":"Success, team was deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a team with that teamId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:delete"]},"x-purecloud-method-name":"deleteTeam"},"patch":{"tags":["Teams"],"summary":"Update team","description":"","operationId":"patchTeam","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"Team ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Team","required":true,"schema":{"$ref":"#/definitions/Team"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Team"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","group.name.in.use":"Team with specified name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:edit"]},"x-purecloud-method-name":"patchTeam"}},"/api/v2/teams":{"get":{"tags":["Teams"],"summary":"Get Team listing","description":"","operationId":"getTeams","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Return only teams whose names start with this value (case-insensitive matching)","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the next item in the complete list of teams","required":false,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the previous item in the complete list of teams","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand the name on each user","required":false,"type":"string","enum":["entities.division"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TeamEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:view"]},"x-purecloud-method-name":"getTeams"},"post":{"tags":["Teams"],"summary":"Create a team","description":"","operationId":"postTeams","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Team","required":true,"schema":{"$ref":"#/definitions/Team"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Team"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","group.name.in.use":"Team with specified name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:add"]},"x-purecloud-method-name":"postTeams"}},"/api/v2/teams/search":{"post":{"tags":["Teams","Search"],"summary":"Search resources.","description":"","operationId":"postTeamsSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/TeamSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TeamsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:view"]},"x-purecloud-method-name":"postTeamsSearch"}},"/api/v2/telephony/mediaregions":{"get":{"tags":["Telephony"],"summary":"Retrieve the list of AWS regions media can stream through.","description":"","operationId":"getTelephonyMediaregions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MediaRegions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyMediaregions"}},"/api/v2/stations/{stationId}":{"get":{"tags":["Stations"],"summary":"Get station.","description":"","operationId":"getStation","produces":["application/json"],"parameters":[{"name":"stationId","in":"path","description":"Station ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Station"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Specified station resource not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations","stations:readonly"]}],"x-purecloud-method-name":"getStation"}},"/api/v2/stations/{stationId}/associateduser":{"delete":{"tags":["Stations"],"summary":"Unassigns the user assigned to this station","description":"","operationId":"deleteStationAssociateduser","produces":["application/json"],"parameters":[{"name":"stationId","in":"path","description":"Station ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations"]}],"x-purecloud-method-name":"deleteStationAssociateduser"}},"/api/v2/stations":{"get":{"tags":["Stations"],"summary":"Get the list of available stations.","description":"","operationId":"getStations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"userSelectable","in":"query","description":"True for stations that the user can select otherwise false","required":false,"type":"string"},{"name":"webRtcUserId","in":"query","description":"Filter for the webRtc station of the webRtcUserId","required":false,"type":"string"},{"name":"id","in":"query","description":"Comma separated list of stationIds","required":false,"type":"string"},{"name":"lineAppearanceId","in":"query","description":"lineAppearanceId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.organization.type":"Collaborate organizations do not have permission to work with stations","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","unknown":"Unspecified error getting station listing."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error getting station listing.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations","stations:readonly"]}],"x-purecloud-method-name":"getStations"}},"/api/v2/telephony/sipmessages/conversations/{conversationId}/headers":{"get":{"tags":["Telephony"],"summary":"Get SIP headers.","description":"Get parsed SIP headers. Returns specific headers if key query parameters are added.","operationId":"getTelephonySipmessagesConversationHeaders","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation id","required":true,"type":"string"},{"name":"keys","in":"query","description":"comma-separated list of header identifiers to query. e.g. ruri,to,from","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Callheader"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:view"]},"x-purecloud-method-name":"getTelephonySipmessagesConversationHeaders"}},"/api/v2/telephony/sipmessages/conversations/{conversationId}":{"get":{"tags":["Telephony"],"summary":"Get a SIP message.","description":"Get the raw form of the SIP message","operationId":"getTelephonySipmessagesConversation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Callmessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:view"]},"x-purecloud-method-name":"getTelephonySipmessagesConversation"}},"/api/v2/telephony/providers/edges/addressvalidation":{"post":{"tags":["Telephony Providers Edge"],"summary":"Validates a street address","description":"","operationId":"postTelephonyProvidersEdgesAddressvalidation","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Address","required":true,"schema":{"$ref":"#/definitions/ValidateAddressRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ValidateAddressResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-purecloud-method-name":"postTelephonyProvidersEdgesAddressvalidation"}},"/api/v2/telephony/providers/edges/certificateauthorities":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of certificate authorities.","description":"","operationId":"getTelephonyProvidersEdgesCertificateauthorities","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CertificateAuthorityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesCertificateauthorities"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a certificate authority.","description":"","operationId":"postTelephonyProvidersEdgesCertificateauthorities","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CertificateAuthority","required":true,"schema":{"$ref":"#/definitions/DomainCertificateAuthority"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesCertificateauthorities"}},"/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a certificate authority.","description":"","operationId":"getTelephonyProvidersEdgesCertificateauthority","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Certificate authority resource not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesCertificateauthority"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a certificate authority.","description":"","operationId":"putTelephonyProvidersEdgesCertificateauthority","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Certificate authority","required":true,"schema":{"$ref":"#/definitions/DomainCertificateAuthority"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesCertificateauthority"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a certificate authority.","description":"","operationId":"deleteTelephonyProvidersEdgesCertificateauthority","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Certificate authority resource not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesCertificateauthority"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticTracepath","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Request badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticTracepath"},"post":{"tags":["Telephony Providers Edge"],"summary":"Tracepath request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticTracepath","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticTracepath"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticNslookup","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticNslookup"},"post":{"tags":["Telephony Providers Edge"],"summary":"Nslookup request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticNslookup","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticNslookup"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticPing","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticPing"},"post":{"tags":["Telephony Providers Edge"],"summary":"Ping Request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticPing","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticPing"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/route":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticRoute","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticRoute"},"post":{"tags":["Telephony Providers Edge"],"summary":"Route request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticRoute","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticRoute"}},"/api/v2/telephony/providers/edges/{edgeId}/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot an Edge","description":"","operationId":"postTelephonyProvidersEdgeReboot","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Parameters for the edge reboot","required":false,"schema":{"$ref":"#/definitions/EdgeRebootParameters"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge was not found.","general.resource.not.found":"Edge was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeReboot"}},"/api/v2/telephony/providers/edges/{edgeId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge.","description":"","operationId":"getTelephonyProvidersEdge","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["site"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge was not found.","general.resource.not.found":"Edge was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdge"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a edge.","description":"","operationId":"putTelephonyProvidersEdge","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Edge","required":true,"schema":{"$ref":"#/definitions/Edge"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","fingerprint.too.early":"Fingerprint sent before awaiting fingerprint verification","cant.modify.edge.group":"Edge group cannot be modified when edge is in service.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","site.required":"The site field is missing a value.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","edge.group.required":"The edge group field is missing a value.","incorrect.fingerprint":"The provided edge fingerprint was not correct.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","editing.managed.property.not.allowed":"Editing managed properties is not allowed.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","managed.property.not.allowed":"Not allowed to modify a managed edge."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdge"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a edge.","description":"","operationId":"deleteTelephonyProvidersEdge","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge was not found.","general.resource.not.found":"Edge was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdge"}},"/api/v2/telephony/providers/edges/{edgeId}/statuscode":{"post":{"tags":["Telephony Providers Edge"],"summary":"Take an Edge in or out of service","description":"","operationId":"postTelephonyProvidersEdgeStatuscode","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Edge Service State","required":false,"schema":{"$ref":"#/definitions/EdgeServiceStateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The active Edge(s) assigned to a Site must all be assigned to the same Edge Group.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Specified edgeId not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeStatuscode"}},"/api/v2/telephony/providers/edges/{edgeId}/softwareupdate":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets software update status information about any edge.","description":"","operationId":"getTelephonyProvidersEdgeSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgeSoftwareupdate"},"post":{"tags":["Telephony Providers Edge"],"summary":"Starts a software update for this edge.","description":"","operationId":"postTelephonyProvidersEdgeSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Software update request","required":true,"schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","managed.property.not.allowed":"Not allowed to set managed property."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-purecloud-method-name":"postTelephonyProvidersEdgeSoftwareupdate"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Cancels any in-progress update for this edge.","description":"","operationId":"deleteTelephonyProvidersEdgeSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-purecloud-method-name":"deleteTelephonyProvidersEdgeSoftwareupdate"}},"/api/v2/telephony/providers/edges/{edgeId}/softwareversions":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets all the available software versions for this edge.","description":"","operationId":"getTelephonyProvidersEdgeSoftwareversions","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareVersionDtoEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Request badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgeSoftwareversions"}},"/api/v2/telephony/providers/edges/timezones":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Edge-compatible time zones","description":"","operationId":"getTelephonyProvidersEdgesTimezones","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":1000,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeZoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgesTimezones"}},"/api/v2/telephony/providers/edges/{edgeId}/unpair":{"post":{"tags":["Telephony Providers Edge"],"summary":"Unpair an Edge","description":"","operationId":"postTelephonyProvidersEdgeUnpair","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","managed.property.not.allowed":"Not allowed to set managed property."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"edge.offline":"Cannot unpair an edge that is offline.","site.has.enabled.connections":"Cannot remove a site from an edge that has enabled site connection.","conflict":"The Edge must have an inactive state to complete this operation."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeUnpair"}},"/api/v2/telephony/providers/edges/edgeversionreport":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the edge version report.","description":"The report will not have consistent data about the edge version(s) until all edges have been reset.","operationId":"getTelephonyProvidersEdgesEdgeversionreport","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeVersionReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgeversionreport"}},"/api/v2/telephony/providers/edges/logicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge logical interfaces.","description":"Retrieve the configured logical interfaces for a list edges. Only 100 edges can be requested at a time.","operationId":"getTelephonyProvidersEdgesLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeIds","in":"query","description":"Comma separated list of Edge Id's","required":true,"type":"string"},{"name":"expand","in":"query","description":"Field to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["externalTrunkBaseAssignments","phoneTrunkBaseAssignments"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLogicalinterfaces"}},"/api/v2/telephony/providers/edges/physicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get physical interfaces for edges.","description":"Retrieves a list of all configured physical interfaces for a list of edges. Only 100 edges can be requested at a time.","operationId":"getTelephonyProvidersEdgesPhysicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeIds","in":"query","description":"Comma separated list of Edge Id's","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhysicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhysicalinterfaces"}},"/api/v2/telephony/providers/edges":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of edges.","description":"","operationId":"getTelephonyProvidersEdges","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"edgeGroup.id","in":"query","description":"Filter by edgeGroup.id","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"},{"name":"showCloudMedia","in":"query","description":"True to show the cloud media devices in the result.","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","unknown":"Unspecified error getting edge listing."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error while getting edge listing.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdges"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge.","description":"","operationId":"postTelephonyProvidersEdges","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Edge","required":true,"schema":{"$ref":"#/definitions/Edge"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","duplicate.edge.name":"The edge name is already in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdges"}},"/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an edge logical interface","description":"","operationId":"getTelephonyProvidersEdgeLogicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Field to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["externalTrunkBaseAssignments","phoneTrunkBaseAssignments"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLogicalinterface"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an edge logical interface.","description":"","operationId":"putTelephonyProvidersEdgeLogicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Logical interface","required":true,"schema":{"$ref":"#/definitions/DomainLogicalInterface"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Information was missing or malformed in the request","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"A logical interface with that vlanTagId already exists on this port.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Logical interface cannot be modified in current state."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgeLogicalinterface"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an edge logical interface","description":"","operationId":"deleteTelephonyProvidersEdgeLogicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgeLogicalinterface"}},"/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge logical interfaces.","description":"Retrieve a list of all configured logical interfaces from a specific edge.","operationId":"getTelephonyProvidersEdgeLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Field to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["externalTrunkBaseAssignments","phoneTrunkBaseAssignments"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLogicalinterfaces"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge logical interface.","description":"Create","operationId":"postTelephonyProvidersEdgeLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Logical interface","required":true,"schema":{"$ref":"#/definitions/DomainLogicalInterface"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"A logical interface with that vlanTagId already exists on this port.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeLogicalinterfaces"}},"/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge physical interface.","description":"Retrieve a physical interface from a specific edge.","operationId":"getTelephonyProvidersEdgePhysicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainPhysicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgePhysicalinterface"}},"/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Retrieve a list of all configured physical interfaces from a specific edge.","description":"","operationId":"getTelephonyProvidersEdgePhysicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhysicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgePhysicalinterfaces"}},"/api/v2/telephony/providers/edges/didpools/{didPoolId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a DID Pool by ID.","description":"","operationId":"getTelephonyProvidersEdgesDidpool","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The DID Pool was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDidpool"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a DID Pool by ID.","description":"","operationId":"putTelephonyProvidersEdgesDidpool","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DID pool","required":true,"schema":{"$ref":"#/definitions/DIDPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The DID Pool was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesDidpool"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a DID Pool by ID.","description":"","operationId":"deleteTelephonyProvidersEdgesDidpool","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Edge group was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesDidpool"}},"/api/v2/telephony/providers/edges/didpools/dids":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of unassigned and/or assigned numbers in a set of DID Pools.","description":"","operationId":"getTelephonyProvidersEdgesDidpoolsDids","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"The type of numbers to return.","required":true,"type":"string","enum":["ASSIGNED_AND_UNASSIGNED","UNASSIGNED"]},{"name":"id","in":"query","description":"Filter by a specific list of DID Pools. If this is not provided, numbers from all DID Pools will be returned.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"numberMatch","in":"query","description":"A number to filter the results by.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDNumberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDidpoolsDids"}},"/api/v2/telephony/providers/edges/didpools":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of DID Pools","description":"","operationId":"getTelephonyProvidersEdgesDidpools","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"id","in":"query","description":"Filter by a specific list of ID's","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPoolEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDidpools"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new DID pool","description":"","operationId":"postTelephonyProvidersEdgesDidpools","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DID pool","required":true,"schema":{"$ref":"#/definitions/DIDPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesDidpools"}},"/api/v2/telephony/providers/edges/dids/{didId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a DID by ID.","description":"","operationId":"getTelephonyProvidersEdgesDid","produces":["application/json"],"parameters":[{"name":"didId","in":"path","description":"DID ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DID"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDid"}},"/api/v2/telephony/providers/edges/dids":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of DIDs","description":"","operationId":"getTelephonyProvidersEdgesDids","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"phoneNumber","in":"query","description":"Filter by phoneNumber","required":false,"type":"string"},{"name":"owner.id","in":"query","description":"Filter by the owner of a phone number","required":false,"type":"string"},{"name":"didPool.id","in":"query","description":"Filter by the DID Pool assignment","required":false,"type":"string"},{"name":"id","in":"query","description":"Filter by a specific list of ID's","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","unknown":"Unspecified error getting DID listings."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDids"}},"/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge group.","description":"","operationId":"getTelephonyProvidersEdgesEdgegroup","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["phoneTrunkBases","edgeTrunkBaseAssignment"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge group was not found.","general.resource.not.found":"Edge group was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgegroup"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an edge group.","description":"","operationId":"putTelephonyProvidersEdgesEdgegroup","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeGroup","required":true,"schema":{"$ref":"#/definitions/EdgeGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"An edge group with this name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","managed.property.not.allowed":"Not allowed to update managed property."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesEdgegroup"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an edge group.","description":"","operationId":"deleteTelephonyProvidersEdgesEdgegroup","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"The request could not be understood by the server due to malformed syntax."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge group was not found.","general.resource.not.found":"Edge group was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesEdgegroup"}},"/api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets the edge trunk base associated with the edge group","description":"","operationId":"getTelephonyProvidersEdgesEdgegroupEdgetrunkbase","produces":["application/json"],"parameters":[{"name":"edgegroupId","in":"path","description":"Edge Group ID","required":true,"type":"string"},{"name":"edgetrunkbaseId","in":"path","description":"Edge Trunk Base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeTrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgegroupEdgetrunkbase"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update the edge trunk base associated with the edge group","description":"","operationId":"putTelephonyProvidersEdgesEdgegroupEdgetrunkbase","produces":["application/json"],"parameters":[{"name":"edgegroupId","in":"path","description":"Edge Group ID","required":true,"type":"string"},{"name":"edgetrunkbaseId","in":"path","description":"Edge Trunk Base ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeTrunkBase","required":true,"schema":{"$ref":"#/definitions/EdgeTrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeTrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesEdgegroupEdgetrunkbase"}},"/api/v2/telephony/providers/edges/edgegroups":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of edge groups.","description":"","operationId":"getTelephonyProvidersEdgesEdgegroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Edge groups not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgegroups"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge group.","description":"","operationId":"postTelephonyProvidersEdgesEdgegroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"EdgeGroup","required":true,"schema":{"$ref":"#/definitions/EdgeGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"An edge group with this name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesEdgegroups"}},"/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an extension pool by ID","description":"","operationId":"getTelephonyProvidersEdgesExtensionpool","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an extension pool with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:extensionPool:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtensionpool"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an extension pool by ID","description":"","operationId":"putTelephonyProvidersEdgesExtensionpool","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExtensionPool","required":true,"schema":{"$ref":"#/definitions/ExtensionPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an extension pool with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:extensionPool:edit"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesExtensionpool"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an extension pool by ID","description":"","operationId":"deleteTelephonyProvidersEdgesExtensionpool","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an extension pool with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:extensionPool:delete"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesExtensionpool"}},"/api/v2/telephony/providers/edges/extensionpools/divisionviews":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a pageable list of basic extension pool objects filterable by query parameters.","description":"This returns extension pools consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.","operationId":"getTelephonyProvidersEdgesExtensionpoolsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"id","in":"query","description":"ID of the Extension Pools to filter by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name of the Extension Pools to filter by.","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"List of divisionIds on which to filter.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPoolDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:extensionPool:search"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtensionpoolsDivisionviews"}},"/api/v2/telephony/providers/edges/extensionpools":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of extension pools","description":"","operationId":"getTelephonyProvidersEdgesExtensionpools","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"number","in":"query","description":"Deprecated, filtering by number not supported","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPoolEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:extensionPool:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtensionpools"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new extension pool","description":"","operationId":"postTelephonyProvidersEdgesExtensionpools","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExtensionPool","required":true,"schema":{"$ref":"#/definitions/ExtensionPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:extensionPool:add"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesExtensionpools"}},"/api/v2/telephony/providers/edges/extensions/{extensionId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an extension by ID.","description":"","operationId":"getTelephonyProvidersEdgesExtension","produces":["application/json"],"parameters":[{"name":"extensionId","in":"path","description":"Extension ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Extension"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:extensionPool:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtension"}},"/api/v2/telephony/providers/edges/extensions":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of extensions","description":"","operationId":"getTelephonyProvidersEdgesExtensions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"number","in":"query","description":"Filter by number","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:extensionPool:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtensions"}},"/api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a line base settings object by ID","description":"","operationId":"getTelephonyProvidersEdgesLinebasesetting","produces":["application/json"],"parameters":[{"name":"lineBaseId","in":"path","description":"Line base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a line with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLinebasesetting"}},"/api/v2/telephony/providers/edges/linebasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of line base settings objects","description":"","operationId":"getTelephonyProvidersEdgesLinebasesettings","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLinebasesettings"}},"/api/v2/telephony/providers/edges/lines/{lineId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Line by ID","description":"","operationId":"getTelephonyProvidersEdgesLine","produces":["application/json"],"parameters":[{"name":"lineId","in":"path","description":"Line ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Line"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an outbound route with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLine"}},"/api/v2/telephony/providers/edges/lines":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Lines","description":"","operationId":"getTelephonyProvidersEdgesLines","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated. The edgeGroup value is deprecated.","required":false,"type":"array","items":{"type":"string","enum":["properties","site","edgeGroup","primaryEdge","secondaryEdge","edges","assignedUser"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLines"}},"/api/v2/telephony/providers/edges/lines/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance","description":"","operationId":"getTelephonyProvidersEdgesLinesTemplate","produces":["application/json"],"parameters":[{"name":"lineBaseSettingsId","in":"query","description":"The id of a Line Base Settings object upon which to base this Line","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Line"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a line with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLinesTemplate"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an Edge logs job.","description":"","operationId":"getTelephonyProvidersEdgeLogsJob","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"}],"responses":{"200":{"description":"Edge log list has been returned in the response.","schema":{"$ref":"#/definitions/EdgeLogsJob"}},"202":{"description":"Accepted - Processing Edge logs job, try again soon."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the Edge logs job by given Id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLogsJob"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload":{"post":{"tags":["Telephony Providers Edge"],"summary":"Request that the specified fileIds be uploaded from the Edge.","description":"","operationId":"postTelephonyProvidersEdgeLogsJobUpload","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Log upload request","required":true,"schema":{"$ref":"#/definitions/EdgeLogsJobUploadRequest"}}],"responses":{"202":{"description":"Accepted - Files are being uploaded to the job. Watch the uploadStatus property on the job files."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find resource by given id(s).","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeLogsJobUpload"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs":{"post":{"tags":["Telephony Providers Edge"],"summary":"Create a job to upload a list of Edge logs.","description":"","operationId":"postTelephonyProvidersEdgeLogsJobs","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeLogsJobRequest","required":true,"schema":{"$ref":"#/definitions/EdgeLogsJobRequest"}}],"responses":{"202":{"description":"Accepted - Job is being processed. The job ID is returned.","schema":{"$ref":"#/definitions/EdgeLogsJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeLogsJobs"}},"/api/v2/telephony/providers/edges/{edgeId}/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the edge metrics.","description":"","operationId":"getTelephonyProvidersEdgeMetrics","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeMetrics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find edge metrics by given id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeMetrics"}},"/api/v2/telephony/providers/edges/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the metrics for a list of edges.","description":"","operationId":"getTelephonyProvidersEdgesMetrics","produces":["application/json"],"parameters":[{"name":"edgeIds","in":"query","description":"Comma separated list of Edge Id's. Maximum of 100 edge ids allowed.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/EdgeMetrics"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request could not be processed due to invalid request data.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesMetrics"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Classifications for this Site","description":"","operationId":"getTelephonyProvidersEdgesSiteNumberplansClassifications","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"classification","in":"query","description":"Classification","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteNumberplansClassifications"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Number Plan by ID.","description":"","operationId":"getTelephonyProvidersEdgesSiteNumberplan","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"numberPlanId","in":"path","description":"Number Plan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NumberPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a number plan with that id","general.resource.not.found":"Unable to find a number plan with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteNumberplan"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of Number Plans for this Site. Only fetches the first 200 records.","description":"","operationId":"getTelephonyProvidersEdgesSiteNumberplans","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteNumberplans"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update the list of Number Plans. A user can update maximum 200 number plans at a time.","description":"","operationId":"putTelephonyProvidersEdgesSiteNumberplans","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of number plans","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"number.plan.in.use":"The number plan is in use by one or more outbound route.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","error.updating.number.plans":"There was a problem updating number plans.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.number.plan.name":"Number Plan names must be unique.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a number plan with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesSiteNumberplans"}},"/api/v2/telephony/providers/edges/outboundroutes":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound routes","description":"","operationId":"getTelephonyProvidersEdgesOutboundroutes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"externalTrunkBases.ids","in":"query","description":"Filter by externalTrunkBases.ids","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find an outbound route with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesOutboundroutes"}},"/api/v2/telephony/providers/edges/phonebasesettings/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesettingsTemplate","produces":["application/json"],"parameters":[{"name":"phoneMetabaseId","in":"query","description":"The id of a metabase object upon which to base this Phone Base Settings","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesettingsTemplate"}},"/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone Base Settings object by ID","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesetting","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a phone with that id.","general.resource.not.found":"Unable to find a Phone Base Settings with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unable.to.expand.properties":"Server error, unable to expand base setting properties.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesetting"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Phone Base Settings by ID","description":"","operationId":"putTelephonyProvidersEdgesPhonebasesetting","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Phone base settings","required":true,"schema":{"$ref":"#/definitions/PhoneBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a phone with that id","general.resource.not.found":"Unable to find a phone with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"2 or more modifications of the phone base were made at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesPhonebasesetting"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Phone Base Settings by ID","description":"","operationId":"deleteTelephonyProvidersEdgesPhonebasesetting","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to delete Phone Base Settings with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Phone template cannot be modified in current state."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesPhonebasesetting"}},"/api/v2/telephony/providers/edges/phonebasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Phone Base Settings objects","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesettings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties","lines"]},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.organization.type":"Organization type is invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Phone base not found.","general.resource.not.found":"Phone base not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","unknown":"Unspecified error getting phone base settings."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesettings"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new Phone Base Settings object","description":"","operationId":"postTelephonyProvidersEdgesPhonebasesettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Phone base settings","required":true,"schema":{"$ref":"#/definitions/PhoneBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","webrtc.user.required":"A webRtc user is required.","base.settings.required":"A base setting is required.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhonebasesettings"}},"/api/v2/telephony/providers/edges/phonebasesettings/availablemetabases":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of available makes and models to create a new Phone Base Settings","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneMetaBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases"}},"/api/v2/telephony/providers/edges/phones/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance","description":"","operationId":"getTelephonyProvidersEdgesPhonesTemplate","produces":["application/json"],"parameters":[{"name":"phoneBaseSettingsId","in":"query","description":"The id of a Phone Base Settings object upon which to base this Phone","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonesTemplate"}},"/api/v2/telephony/providers/edges/phones/{phoneId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone by ID","description":"","operationId":"getTelephonyProvidersEdgesPhone","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the phone with that Id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","unknown":"Unspecified error find phone with that Id."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhone"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Phone by ID","description":"","operationId":"putTelephonyProvidersEdgesPhone","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Phone","required":true,"schema":{"$ref":"#/definitions/Phone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","webrtc.user.required":"A webRtcUser is required.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","access.denied.to.field":"You are not authorized to view one or more of the referenced entities."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to update Phone with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"2 or more modifications of the phone were made at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesPhone"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Phone by ID","description":"","operationId":"deleteTelephonyProvidersEdgesPhone","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"The request could not be understood by the server due to malformed syntax."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to delete Phone with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesPhone"}},"/api/v2/telephony/providers/edges/phones":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Phone Instances. A maximum of 10,000 results is returned when filtering the results or sorting by a field other than the ID. Sorting by only the ID has no result limit. Each filter supports a wildcard, *, as a value to search for partial values.","description":"","operationId":"getTelephonyProvidersEdgesPhones","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"The field to sort by","required":false,"type":"string","default":"name","enum":["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."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhones"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new Phone","description":"","operationId":"postTelephonyProvidersEdgesPhones","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Phone","required":true,"schema":{"$ref":"#/definitions/Phone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","lines.required":"A phone cannot be created without a line.","invalid.property":"Value [%s] is not a valid property for object [%s]","base.settings.required":"A base setting must be assigned to create a phone.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","access.denied.to.field":"You are not authorized to view one or more of the referenced entities."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","unknown":"Unspecified error posting phone instance."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhones"}},"/api/v2/telephony/providers/edges/phones/{phoneId}/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot a Phone","description":"","operationId":"postTelephonyProvidersEdgesPhoneReboot","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone Id","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","providerapi.error.phone.no.active.edge":"Phone is not connected to an active edge and cannot be rebooted."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhoneReboot"}},"/api/v2/telephony/providers/edges/phones/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot Multiple Phones","description":"","operationId":"postTelephonyProvidersEdgesPhonesReboot","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Phones","required":true,"schema":{"$ref":"#/definitions/PhonesReboot"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","providerapi.error.phone.no.active.edge":"Phone is not connected to an active edge and cannot be rebooted."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhonesReboot"}},"/api/v2/telephony/providers/edges/expired":{"get":{"tags":["Telephony Providers Edge"],"summary":"List of edges more than 4 edge versions behind the latest software.","description":"","operationId":"getTelephonyProvidersEdgesExpired","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExpiredEdgeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","internal:edge:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExpired"}},"/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get site connections for a site.","description":"","operationId":"getTelephonyProvidersEdgesSiteSiteconnections","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SiteConnections"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a site with that id","general.resource.not.found":"Unable to find a site with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","telephony:sites:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteSiteconnections"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update site connections for a site.","description":"","operationId":"putTelephonyProvidersEdgesSiteSiteconnections","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Site","required":true,"schema":{"$ref":"#/definitions/SiteConnections"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SiteConnections"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"General Bad Request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Site resource not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesSiteSiteconnections"},"patch":{"tags":["Telephony Providers Edge"],"summary":"Disable site connections for a site.","description":"","operationId":"patchTelephonyProvidersEdgesSiteSiteconnections","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Site","required":true,"schema":{"$ref":"#/definitions/DisableSiteConnectionsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SiteConnections"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"General Bad Request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Site resource not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"patchTelephonyProvidersEdgesSiteSiteconnections"}},"/api/v2/telephony/providers/edges/sites/{siteId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Site by ID.","description":"","operationId":"getTelephonyProvidersEdgesSite","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a site with that id","general.resource.not.found":"Unable to find a site with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","telephony:sites:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSite"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Site by ID.","description":"","operationId":"putTelephonyProvidersEdgesSite","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Site","required":true,"schema":{"$ref":"#/definitions/Site"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","referenced.key.does.not.exist":"The request could not be understood by the server due to malformed syntax.","managed.property.not.allowed":"Not allowed to update managed property","duplicate.value":"At least one of the values in the request were a duplicate.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","managed.property.not.allowed":"NEEDED"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a site with that id","general.resource.not.found":"Unable to find a site with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"2 or more modifications of the site were made at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesSite"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Site by ID","description":"","operationId":"deleteTelephonyProvidersEdgesSite","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","managed.property.not.allowed":"Not allowed to delete a managed site."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a site with that id","general.resource.not.found":"Unable to find a site with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.referenced.by.another":"The site is referenced by another resource.","general.conflict":"The site is being referenced or is set as the default site."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesSite"}},"/api/v2/telephony/providers/edges/sites":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of Sites.","description":"","operationId":"getTelephonyProvidersEdgesSites","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"location.id","in":"query","description":"Location Id","required":false,"type":"string"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["edges","location","primarySites","secondarySites"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SiteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgesSites"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a Site.","description":"","operationId":"postTelephonyProvidersEdgesSites","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Site","required":true,"schema":{"$ref":"#/definitions/Site"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","referenced.key.does.not.exist":"Unable to find entity that matches the key.","duplicate.value":"At least one of the values in the request were a duplicate.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesSites"}},"/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an outbound route","description":"","operationId":"getTelephonyProvidersEdgesSiteOutboundroute","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteOutboundroute"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update outbound route","description":"","operationId":"putTelephonyProvidersEdgesSiteOutboundroute","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"},{"in":"body","name":"body","description":"OutboundRoute","required":true,"schema":{"$ref":"#/definitions/OutboundRouteBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"An outbound route with this name already exists.","address.classification.type.does.not.exist":"One of the address classifications does not exist.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Dependent entities exist."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesSiteOutboundroute"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete Outbound Route","description":"","operationId":"deleteTelephonyProvidersEdgesSiteOutboundroute","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesSiteOutboundroute"}},"/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound routes","description":"","operationId":"getTelephonyProvidersEdgesSiteOutboundroutes","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"externalTrunkBases.ids","in":"query","description":"externalTrunkBases.ids","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteOutboundroutes"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create outbound route","description":"","operationId":"postTelephonyProvidersEdgesSiteOutboundroutes","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"OutboundRoute","required":true,"schema":{"$ref":"#/definitions/OutboundRouteBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"An outbound route with this name already exists.","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","number.plan.type.usage.must.be.unique":"The number plan type usage must be unique.","address.classification.type.does.not.exist\t":"The address classification does not exist.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesSiteOutboundroutes"}},"/api/v2/telephony/providers/edges/trunks/{trunkId}/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the trunk metrics.","description":"","operationId":"getTelephonyProvidersEdgesTrunkMetrics","produces":["application/json"],"parameters":[{"name":"trunkId","in":"path","description":"Trunk Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkMetrics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the trunk metrics with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkMetrics"}},"/api/v2/telephony/providers/edges/trunks/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the metrics for a list of trunks.","description":"","operationId":"getTelephonyProvidersEdgesTrunksMetrics","produces":["application/json"],"parameters":[{"name":"trunkIds","in":"query","description":"Comma separated list of Trunk Id's","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/TrunkMetrics"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunksMetrics"}},"/api/v2/telephony/providers/edges/trunkbasesettings/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance","description":"","operationId":"getTelephonyProvidersEdgesTrunkbasesettingsTemplate","produces":["application/json"],"parameters":[{"name":"trunkMetabaseId","in":"query","description":"The id of a metabase object upon which to base this Trunk Base Settings","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesettingsTemplate"}},"/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk Base Settings object by ID","description":"Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission.","operationId":"getTelephonyProvidersEdgesTrunkbasesetting","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"},{"name":"ignoreHidden","in":"query","description":"Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"The requested entity was not found.","general.resource.not.found":"Unable to find the trunk base settings with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesetting"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Trunk Base Settings object by ID","description":"","operationId":"putTelephonyProvidersEdgesTrunkbasesetting","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Trunk base settings","required":true,"schema":{"$ref":"#/definitions/TrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","validation.error":"Error validating the data.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"A trunk with that name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","general.access.denied":"The requested action is forbidden.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"The requested entity was not found.","general.resource.not.found":"The requested resource was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be made due to conflict with the server resources"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesTrunkbasesetting"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Trunk Base Settings object by ID","description":"","operationId":"deleteTelephonyProvidersEdgesTrunkbasesetting","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"delete.referenced.entity":"The trunk is being referenced.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"The request could not be understood by the server due to malformed syntax."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"The requested entity was not found.","general.resource.not.found":"Unable to delete trunk base settings with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesTrunkbasesetting"}},"/api/v2/telephony/providers/edges/trunkbasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get Trunk Base Settings listing","description":"Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission.","operationId":"getTelephonyProvidersEdgesTrunkbasesettings","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"recordingEnabled","in":"query","description":"Filter trunks by recording enabled","required":false,"type":"boolean"},{"name":"ignoreHidden","in":"query","description":"Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.","required":false,"type":"boolean"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties"]},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name of the TrunkBase to filter by","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.resource.not.found":"Trunk base settings not found","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesettings"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a Trunk Base Settings object","description":"","operationId":"postTelephonyProvidersEdgesTrunkbasesettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Trunk base settings","required":true,"schema":{"$ref":"#/definitions/TrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","trunk.metabase.required":"A metabase is required for this function.","duplicate.value":"A trunk with that name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","general.access.denied":"The requested action is forbidden.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be made due to conflict with the server resources"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesTrunkbasesettings"}},"/api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of available makes and models to create a new Trunk Base Settings","description":"","operationId":"getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases","produces":["application/json"],"parameters":[{"name":"type","in":"query","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"]},{"name":"pageSize","in":"query","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkMetabaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases"}},"/api/v2/telephony/providers/edges/trunkswithrecording":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get Counts of trunks that have recording disabled or enabled","description":"","operationId":"getTelephonyProvidersEdgesTrunkswithrecording","produces":["application/json"],"parameters":[{"name":"trunkType","in":"query","description":"The type of this trunk base.","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkRecordingEnabledCount"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:view","telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkswithrecording"}},"/api/v2/telephony/providers/edges/{edgeId}/trunks":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of available trunks for the given Edge.","description":"Trunks are created by assigning trunk base settings to an Edge or Edge Group.","operationId":"getTelephonyProvidersEdgeTrunks","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"trunkBase.id","in":"query","description":"Filter by Trunk Base Ids","required":false,"type":"string"},{"name":"trunkType","in":"query","description":"Filter by a Trunk type","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.resource.not.found":"Specified edgeId not found.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeTrunks"}},"/api/v2/telephony/providers/edges/trunks/{trunkId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk by ID","description":"","operationId":"getTelephonyProvidersEdgesTrunk","produces":["application/json"],"parameters":[{"name":"trunkId","in":"path","description":"Trunk ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trunk"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Trunk ID not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunk"}},"/api/v2/telephony/providers/edges/trunks":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of available trunks.","description":"Trunks are created by assigning trunk base settings to an Edge or Edge Group.","operationId":"getTelephonyProvidersEdgesTrunks","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"edge.id","in":"query","description":"Filter by Edge Ids","required":false,"type":"string"},{"name":"trunkBase.id","in":"query","description":"Filter by Trunk Base Ids","required":false,"type":"string"},{"name":"trunkType","in":"query","description":"Filter by a Trunk type","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Available Trunk resources not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunks"}},"/api/v2/telephony/providers/edges/{edgeId}/setuppackage":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.","description":"","operationId":"getTelephonyProvidersEdgeSetuppackage","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VmPairingInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeSetuppackage"}},"/api/v2/telephony/siptraces":{"get":{"tags":["Telephony"],"summary":"Fetch SIP metadata","description":"Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected","operationId":"getTelephonySiptraces","produces":["application/json"],"parameters":[{"name":"callId","in":"query","description":"unique identification of the placed call","required":false,"type":"string"},{"name":"toUser","in":"query","description":"User to who the call was placed","required":false,"type":"string"},{"name":"fromUser","in":"query","description":"user who placed the call","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"Unique identification of the conversation","required":false,"type":"string"},{"name":"dateStart","in":"query","description":"Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"},{"name":"dateEnd","in":"query","description":"End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SipSearchResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:view"]},"x-purecloud-method-name":"getTelephonySiptraces"}},"/api/v2/telephony/siptraces/download":{"post":{"tags":["Telephony"],"summary":"Request a download of a pcap file to S3","description":"","operationId":"postTelephonySiptracesDownload","produces":["application/json"],"parameters":[{"in":"body","name":"SIPSearchPublicRequest","required":true,"schema":{"$ref":"#/definitions/SIPSearchPublicRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SipDownloadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:add"]},"x-purecloud-method-name":"postTelephonySiptracesDownload"}},"/api/v2/telephony/siptraces/download/{downloadId}":{"get":{"tags":["Telephony"],"summary":"Get signed S3 URL for a pcap download","description":"","operationId":"getTelephonySiptracesDownloadDownloadId","produces":["application/json"],"parameters":[{"name":"downloadId","in":"path","description":"unique id for the downloaded file in S3","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SignedUrlResponse"}},"202":{"description":"Request to download pcap file has been accepted","schema":{"$ref":"#/definitions/SignedUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:view"]},"x-purecloud-method-name":"getTelephonySiptracesDownloadDownloadId"}},"/api/v2/infrastructureascode/accelerators/{acceleratorId}":{"get":{"tags":["Infrastructure as Code"],"summary":"Get information about an accelerator","description":"Get the complete metadata specification for an accelerator, including requirements and parameters.","operationId":"getInfrastructureascodeAccelerator","produces":["application/json"],"parameters":[{"name":"acceleratorId","in":"path","description":"Accelerator ID","required":true,"type":"string"},{"name":"preferredLanguage","in":"query","description":"Preferred Language","required":false,"type":"string","default":"en-US","enum":["ar","cs","da","de","en-US","es","fi","fr","it","iw","ko","ja","nl","no","pl","pt-BR","pt-PT","sv","th","tr","zh-CN","zh-TW"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AcceleratorSpecification"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["infrastructureascode","infrastructureascode:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["infrastructureascode:accelerator:view"]},"x-purecloud-method-name":"getInfrastructureascodeAccelerator"}},"/api/v2/infrastructureascode/accelerators":{"get":{"tags":["Infrastructure as Code"],"summary":"Get a list of available accelerators","description":"Search for accelerators that can be run.","operationId":"getInfrastructureascodeAccelerators","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"name","in":"query","description":"Filter by name","required":false,"type":"string"},{"name":"description","in":"query","description":"Filter by description","required":false,"type":"string"},{"name":"origin","in":"query","description":"Filter by origin","required":false,"type":"string","enum":["community","partner","genesys"]},{"name":"type","in":"query","description":"Filter by type","required":false,"type":"string","enum":["module","accelerator","blueprint"]},{"name":"classification","in":"query","description":"Filter by classification","required":false,"type":"string"},{"name":"tags","in":"query","description":"Filter by tags","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AcceleratorList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["infrastructureascode","infrastructureascode:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["infrastructureascode:accelerator:view"]},"x-purecloud-method-name":"getInfrastructureascodeAccelerators"}},"/api/v2/infrastructureascode/jobs/{jobId}":{"get":{"tags":["Infrastructure as Code"],"summary":"Get job status and results","description":"Get the execution status of a submitted job, optionally including results and error details.","operationId":"getInfrastructureascodeJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"},{"name":"details","in":"query","description":"Include details of execution, including job results or error information","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InfrastructureascodeJob"}},"202":{"description":"Job in progress.","schema":{"$ref":"#/definitions/InfrastructureascodeJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["infrastructureascode","infrastructureascode:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["infrastructureascode:job:view"]},"x-purecloud-method-name":"getInfrastructureascodeJob"}},"/api/v2/infrastructureascode/jobs":{"get":{"tags":["Infrastructure as Code"],"summary":"Get job history","description":"Get a history of submitted jobs, optionally including error messages.","operationId":"getInfrastructureascodeJobs","produces":["application/json"],"parameters":[{"name":"maxResults","in":"query","description":"Number of jobs to show","required":false,"type":"integer","default":1,"format":"int32"},{"name":"includeErrors","in":"query","description":"Include error messages","required":false,"type":"boolean","default":false},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"dateSubmitted","enum":["id","dateSubmitted","submittedBy","acceleratorId","status"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"desc","enum":["asc","desc"]},{"name":"acceleratorId","in":"query","description":"Find only jobs associated with this accelerator","required":false,"type":"string"},{"name":"submittedBy","in":"query","description":"Find only jobs submitted by this user","required":false,"type":"string"},{"name":"status","in":"query","description":"Find only jobs in this state","required":false,"type":"string","enum":["Created","Queued","Running","Complete","Failed","Incomplete"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InfrastructureascodeJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s